diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 16:51:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 16:51:28 +0000 |
commit | 940b4d1848e8c70ab7642901a68594e8016caffc (patch) | |
tree | eb72f344ee6c3d9b80a7ecc079ea79e9fba8676d /odk/examples/DevelopersGuide/UCB/ChildrenRetriever.java | |
parent | Initial commit. (diff) | |
download | libreoffice-940b4d1848e8c70ab7642901a68594e8016caffc.tar.xz libreoffice-940b4d1848e8c70ab7642901a68594e8016caffc.zip |
Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'odk/examples/DevelopersGuide/UCB/ChildrenRetriever.java')
-rw-r--r-- | odk/examples/DevelopersGuide/UCB/ChildrenRetriever.java | 338 |
1 files changed, 338 insertions, 0 deletions
diff --git a/odk/examples/DevelopersGuide/UCB/ChildrenRetriever.java b/odk/examples/DevelopersGuide/UCB/ChildrenRetriever.java new file mode 100644 index 000000000..102119dfc --- /dev/null +++ b/odk/examples/DevelopersGuide/UCB/ChildrenRetriever.java @@ -0,0 +1,338 @@ +/* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/************************************************************************* + * + * The Contents of this file are made available subject to the terms of + * the BSD license. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of Sun Microsystems, Inc. nor the names of its + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR + * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE + * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + *************************************************************************/ + +import java.util.ArrayList; +import java.util.StringTokenizer; + +import com.sun.star.beans.Property; +import com.sun.star.sdbc.XResultSet; +import com.sun.star.sdbc.XRow; +import com.sun.star.ucb.OpenCommandArgument2; +import com.sun.star.ucb.OpenMode; +import com.sun.star.ucb.XContent; +import com.sun.star.ucb.XContentAccess; +import com.sun.star.ucb.XDynamicResultSet; +import com.sun.star.uno.UnoRuntime; + +/** + * Retrieve the Children of a UCB Folder Content + */ +public class ChildrenRetriever { + + /** + * Member properties + */ + private Helper m_helper; + private XContent m_content; + private String m_contenturl = ""; + private ArrayList<String> m_propnames = new ArrayList<String>(); + + /** + * Constructor. Create a new connection with the specific args to a running office + * + *@param args This constructor requires the arguments: + * -url=... (optional) + * -propNames=... (optional) + * See Help (method printCmdLineUsage()). + * Without the arguments a new connection to a + * running office cannot created. + */ + public ChildrenRetriever( String args[] ) throws java.lang.Exception { + + // Parse arguments + parseArguments( args ); + + // Init + m_helper = new Helper( getContentURL() ); + + // Create UCB content + m_content = m_helper.createUCBContent(); + } + + /** + * Open a folder content, get properties values. + * This method requires the main and the optional arguments to be set in order to work. + * See Constructor. + * + *@return Returns children properties values if values successfully retrieved, + * null otherwise + */ + public ArrayList<ArrayList<Object>> getChildren() + throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception { + ArrayList<String> properties = getProperties(); + return getChildren ( properties ); + } + + /** + * Open a folder content, get properties values for the properties. + * + *@return Returns children properties values if values successfully retrieved, + * null otherwise + */ + public ArrayList<ArrayList<Object>> getChildren( ArrayList<String> properties ) + throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception { + + ArrayList<ArrayList<Object>> result = null; + if ( m_content != null ) { + int size = 0; + if ( properties != null && !properties.isEmpty()) { + size = properties.size(); + } + // Fill info for the properties wanted. + Property[] props = new Property[ size ]; + for ( int index = 0 ; index < size; index++ ) { + + // Define property sequence. + Property prop = new Property(); + prop.Name = properties.get( index ); + prop.Handle = -1; // n/a + props[ index ] = prop; + } + + // Fill argument structure... + OpenCommandArgument2 arg = new OpenCommandArgument2(); + arg.Mode = OpenMode.ALL; // FOLDER, DOCUMENTS -> simple filter + arg.Priority = 32768; // static final for 32768 + arg.Properties = props; + + XDynamicResultSet set; + + // Execute command "open". + set = UnoRuntime.queryInterface( + XDynamicResultSet.class, m_helper.executeCommand( m_content, "open", arg )); + XResultSet resultSet = set.getStaticResultSet(); + + result = new ArrayList<ArrayList<Object>>(); + + + // Iterate over children, access children and property values... + + + // Move to begin. + if ( resultSet.first() ) { + XContentAccess contentAccess = UnoRuntime.queryInterface( + XContentAccess.class, resultSet ); + XRow row = UnoRuntime.queryInterface( XRow.class, resultSet ); + + do { + ArrayList<Object> propsValues = new ArrayList<Object>(); + + // Obtain URL of child. + String id = contentAccess.queryContentIdentifierString(); + propsValues.add( id ); + for ( int i = 1; i <= size ; i++) { + Object propValue = row.getObject( i, null ); + if ( !row.wasNull() && !(propValue instanceof com.sun.star.uno.Any )) { + propsValues.add( propValue ); + } else { + propsValues.add( "[ Property not found ]" ); + } + } + result.add( propsValues ); + } while ( resultSet.next() ); // next child + } + } + return result; + } + + /** + * Get connect URL. + * + *@return String That contains the connect URL + */ + public String getContentURL() { + return m_contenturl; + } + + /** + * Get the properties. + * + *@return String That contains the properties + */ + public ArrayList<String> getProperties() { + return m_propnames; + } + + /** + * Parse arguments + * + *@param args Arguments + */ + public void parseArguments( String[] args ) throws java.lang.Exception { + + for ( int i = 0; i < args.length; i++ ) { + if ( args[i].startsWith( "-url=" )) { + m_contenturl = args[i].substring( 5 ); + } else if ( args[i].startsWith( "-propNames=" )) { + StringTokenizer tok + = new StringTokenizer( args[i].substring( 11 ), ";" ); + + while ( tok.hasMoreTokens() ) + m_propnames.add( tok.nextToken() ); + + } else if ( args[i].startsWith( "-help" ) || + args[i].startsWith( "-?" )) { + printCmdLineUsage(); + System.exit( 0 ); + } + } + + if ( m_contenturl == null || m_contenturl.equals( "" )) { + m_contenturl = "file:///"; + } + + if ( m_propnames.size() == 0 ) { + m_propnames.add( "Title" ); + m_propnames.add( "IsDocument" ); + } + } + + /** + * Print the commands options + */ + public void printCmdLineUsage() { + System.out.println( + "Usage : ChildrenRetriever -url=... -propNames=..." ); + System.out.println( + "Defaults: -url=file:/// -propNames=Title,IsDocument" ); + System.out.println( + "\nExample : -url=file:///temp/ -propNames=Title;IsFolder;IsDocument" ); + } + + /** + * Print all properties out contained in vector . + */ + public void printLine( ArrayList<Object> props ) { + int limit; + while ( !props.isEmpty() ) { + String print = ""; + int size = props.size(); + for ( int i = 0; i < size; i++ ) { + limit = 15; + Object obj = props.get( i ); + if ( obj != null) { + String prop = obj.toString(); + int leng = prop.length(); + if ( leng < limit ) { + for ( int l = leng; l < limit; l++) { + prop += " "; + } + print+= prop + " "; + props.set( i, null ); + } else { + String temp1 = prop.substring( 0, limit ); + String temp2 = prop.substring( limit ); + print+= temp1 + " "; + props.set( i, temp2 ); + } + } else { + for ( int l = 0; l < limit; l++) { + print += " "; + } + print+= " "; + } + } + System.out.println( print ); + boolean isEmpty = true; + for ( int i = 0; i < size; i++ ) { + Object obj = props.get( i ); + if( obj != null ) + isEmpty = false; + } + if( isEmpty ) + props.clear(); + } + } + + /** + * Create a new connection with the specific args to a running office and + * access the children from a folder. + */ + public static void main ( String args[] ) { + + System.out.println( "\n" ); + System.out.println( + "-----------------------------------------------------------------" ); + System.out.println( + "ChildrenRetriever - obtains the children of a folder resource." ); + System.out.println( + "-----------------------------------------------------------------" ); + + try { + ChildrenRetriever access = new ChildrenRetriever( args ); + + // Get the properties Title and IsFolder for the children. + ArrayList<ArrayList<Object>> result = access.getChildren(); + + String tempPrint = "\nChildren of resource " + access.getContentURL(); + int size = tempPrint.length(); + System.out.println( tempPrint ); + tempPrint = ""; + for( int i = 0; i < size; i++ ) { + tempPrint += "-"; + } + System.out.println( tempPrint ); + + if ( result != null && !result.isEmpty() ) { + + ArrayList<Object> cont = new ArrayList<Object>(); + cont.add("URL:"); + ArrayList<String> props = access.getProperties(); + size = props.size(); + for ( int i = 0; i < size; i++ ) { + Object obj = props.get( i ); + String prop = obj.toString(); + cont.add( prop + ":" ); + } + access.printLine(cont); + System.out.println( "\n" ); + for ( ArrayList<Object> propsV : result ) { + access.printLine( propsV ); + } + } + } catch ( com.sun.star.ucb.ResultSetException e ) { + System.out.println( "Error: " + e ); + } catch ( com.sun.star.ucb.CommandAbortedException e ) { + System.out.println( "Error: " + e ); + } catch ( com.sun.star.uno.Exception e ) { + System.out.println( "Error: " + e ); + } catch ( java.lang.Exception e ) { + System.out.println( "Error: " + e ); + } + System.exit( 0 ); + } +} + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |