Ignore:
Timestamp:
2010-06-24T13:45:34+12:00 (14 years ago)
Author:
ak19
Message:
  1. Changes to get Fedora to work with Greenstone3: to let the Greenstone3 Reader Interface work with a Fedora Repository behind the scenes. 2. No longer returns XML Strings formatted for display, but unformatted, since when it's converted to XML DOM on the Greenstone end, new lines introduced due to whitespace interfere with Greenstone 3's default parsing of the XML.
File:
1 edited

Legend:

Unmodified
Added
Removed

  • other-projects/gs3-webservices-java-client/trunk/src/GS3Fedora/org/greenstone/fedora/services/FedoraToGS3Interface.java

    r21835 r22300  
    159159   
    160160    /* RETRIEVE SERVICE: DOCUMENT STRUCTURE RETRIEVE */
    161    
    162     /** @return the documentStructure of the document or section given by docID.
    163      * The structure is returned in the XML format of a Greenstone3
    164      * DocumentStructureRetrieve response message. This method returns the entire
    165      * subSection of the docID (that is, all descendents included).
    166      * @param docID the identifier for the document whose structure is required.
    167      * This is either of the format "greenstone:<collectionName>-<docPID>"
    168      * OR "greenstone:<collectionName>-<docPID>-"
    169      * where "greenstone:<collectionName>-<docPID>-1" is the same as
    170      * "greenstone:<collectionName>-<docPID>" and will return the same response */
    171     public String getDocumentStructure(String docID);
    172    
    173     /** @return a view of the structure of the document or section given by docID
    174      * which contains only the section and its direct children. This structure is
    175      * returned in the XML format of a Greenstone3 DocumentStructureRetrieve
    176      * response message.
    177      * @param docID the identifier for the document whose structure is required.
    178      * This is of the format "greenstone:<collectionName>-<docPID>"
    179      * OR "greenstone:<collectionName>-<docPID>-"
    180      * where "greenstone:<collectionName>-<docPID>-1" is the same as
    181      * "greenstone:<collectionName>-<docPID>" and will return the same response */
    182     public String getChildren(String docID);
    183    
    184     /** @return the documentStructure of the documents or sections given by docIDs.
    185      * The structure is returned in the XML format of a Greenstone3
    186      * DocumentStructureRetrieve response message. This method returns the entire
    187      * subSection of each docID (that is, all descendents included).
    188      * @param docIDs an array of document identifiers whose structures are requested
    189      * These are of the format "greenstone:<collectionName>-<docPID>"
    190      * OR "greenstone:<collectionName>-<docPID>-<sectionNumber>"
    191      * where "greenstone:<collectionName>-<docPID>-1" is the same as
    192      * "greenstone:<collectionName>-<docPID>" and will return the same response */
    193     public String getDocumentStructure(String[] docIDs);
    194    
    195     /** @return the documentStructure of the documents or sections given by docIDs
    196      * but only the sections and their children (not any further descendents).
    197      * The structure is returned in the XML format of a Greenstone3
    198      * DocumentStructureRetrieve response message.
    199      * @param docIDs an array of document identifiers whose structures are requested
    200      * These are of the format "greenstone:<collectionName>-<docPID>"
    201      * OR "greenstone:<collectionName>-<docPID>-<sectionNumber>"
    202      * where "greenstone:<collectionName>-<docPID>-1" is the same as
    203      * "greenstone:<collectionName>-<docPID>" and will return the same response */
    204     public String getChildren(String[] docIDs);
    205    
     161
     162        /** @return a String representing Greenstone3 DocumentMetadataRetrieve XML
     163     * containing the requested portion of the document structure of the documents
     164     * indicated by docIDs:
     165     * @param collection is the name of the collection. It's already included in the
     166     * docID for a Fedora DL.
     167     * @param docID is the document identifier of the document whose hierarchical
     168     * structure is requested. The collection name is already included in the
     169     * docID for a Fedora DL.
     170     * @param structure - strings specifying the required structure of the document.
     171     * Any combination of: ancestors, parent, siblings, children, descendants, entire.
     172     * @param info - strings specifying the required structural info of the document.
     173     * It can be any combination of: siblingPosition, numSiblings, numChildren.
     174    */
     175    public String getDocumentStructure(String docID, String[] structure, String[] info);
     176
     177    /** @return a String representing Greenstone3 DocumentMetadataRetrieve XML
     178     * containing the requested portion of the document structure of the documents
     179     * indicated by docIDs:
     180     * @param docIDs is an array of document identifiers of documents whose
     181     * hierarchical structures are requested. The collection name is already included
     182     * in the docID for a Fedora DL.
     183     * @param structure - strings specifying the required structure of each document.
     184     * Any combination of: ancestors, parent, siblings, children, descendants, entire.
     185     * @param info - strings specifying the required structural info of each document.
     186     * It can be any combination of: siblingPosition, numSiblings, numChildren.
     187    */
     188    public String getDocumentStructure(String[] docIDs, String[] structure, String[] info);
     189
    206190   
    207191    /* RETRIEVE SERVICE: DOCUMENT METADATA RETRIEVE */
    … …  
    221205     * @return a GS3 DocumentMetadataRetrieve response message containing the
    222206     * EX, DC, DLS metadata for all the requested documents */
    223     public String getDocumentMetadata(String[] docIDs);
     207    public String getDocumentMetadata(String[] docIDs, String[] metadata);
    224208   
    225209    /** Given a collectionID, returns a GS3 DocumentMetadataRetrieve
    … …  
    237221     * @return a GS3 DocumentMetadataRetrieve response message containing the
    238222     * EX, DC, DLS metadata for all the requested document */
    239     public String getDocumentMetadata(String docID);
     223    public String getDocumentMetadata(String docID, String[] metadata);
    240224
    241225    /** @return a greenstone DocumentMetadataRetrieve response for the
    … …  
    245229     * In the last case, the document ID may consist of either
    246230     * "documentPID-sectionNumber" or may just be just fedora documentPID */
    247     public String getMetadata(String[] docIDsOrCollIDs);
     231    public String getMetadata(String[] docIDsOrCollIDs, String[] metadata);
    248232   
    249233    /** Given a document identifier, returns a GS3 DocumentMetadataRetrieve
    … …  
    271255     * @param classNodeIDs are the IDs of the classifierNode for which the metadata
    272256     * needs to be returned
     257     * @param metafields are the classifier metadata fields that are to be returned.
    273258     * @return a GS3 ClassifierBrowseMetadataRetrieve response message which
    274259     * lists the metadata for all the classifierNodes passed as parameter.*/
    275     public String browseMetadataRetrieve(String[] classNodeIDs);
     260    public String browseMetadataRetrieve(String[] classNodeIDs, String[] metafields);
    276261       
    277262    /** This method performs the implemented browse operation: allowing the
    … …  
    283268     * @param collectionName is the name of the collection whose documents
    284269     * starting with the given letter will be returned.
     270     * @param structure - the requested browse substructure. Can be any combination
     271     * of ancestors, parent, siblings, children, descendants.
     272     * @param info - the requested structural info. Can be numSiblings, siblingPosition,
     273     * numChildren
    285274     * @return a GS3 DocumentStructureRetrieve response message which lists all
    286275     * the documents that start with the letter indicated by parameter classifier.
    287276    */
    288     public String browse(String collectionName, String[] classifierIDs);
     277    public String browse(String collectionName, String[] classifierIDs, String[] structures, String[] infos);
    289278   
    290279    /* @returns the document identifiers returned for a search on the titles of
Note: See TracChangeset for help on using the changeset viewer.