A B C D E F G H I L M N O P Q R S T U W X _

A

addMetadataWithFixedTagName(Document, Element, String, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

This method retrieves all the metadata elements in the metaDataStream of the form <"namespace:"metadata name="metadataName">value</metadata> where "namespace" is the namespace prefix of each tag, and metadataName is the name of the metadata (like author, title).

addMetadataWithNamespacedTagNames(Document, Element, String, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

This method retrieves all the metadata elements in the metaDataStream parameter of the form <"metadataSetNS:metadata">"value"</metadata> where metadataSetNS is the namespace of each tag, and creates a new element of the form <metadata name="metadataSetNS:metadata">"value"</metadata> for each.

ALL_FIELDS - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

Field search names and separator used externally

ALL_TITLES - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

APIA - Static variable in class org.greenstone.fedora.services.FedoraConnection

The object used to access the Fedora API-A web service methods

ASSOCFILEPREFIX - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

Prefix of the (img) files associated with Greenstone documents in the Fedora repository

B

baseURL - Variable in class org.greenstone.fedora.services.FedoraConnection

The location of the fedora server, usually of the form http://localhost:8080/fedora

browse(String, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

This method performs the implemented browse operation: allowing the user to browse the titles of documents in the given collection by letter and returning the results.

browse(String, String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

This method performs the implemented browse operation: allowing the user to browse the titles of documents in the given collection by letter and returning the results.

browseMetadataRetrieve(String[]) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

This method performs something equivalent to a greenstone3 ClassifierBrowseMetadataRetrieve on the classifierNodeIDs

browseMetadataRetrieve(String[]) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

This method performs something equivalent to a greenstone3 ClassifierBrowseMetadataRetrieve on the classifierNodeIDs

browseTitlesByLetter(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

Implements browsing document titles of a greenstone collection stored in the fedora repository by letter.

browseTitlesByLetter(String, String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

Allows browsing document titles of a greenstone collection stored in the fedora repository by letter.

builder - Variable in class org.greenstone.fedora.services.FedoraConnection

DocumentBuilder used to create and parse XML documents

builder - Variable in class org.greenstone.fedora.services.GSearchConnection

A DocumentBuilder object used to construct and parse XML

C

call - Variable in class org.greenstone.fedora.services.GSearchConnection

The Call object used to connect to the FedoraGSearch web services

CHILDREN - Static variable in class org.greenstone.fedora.services.FedoraGS3Connection

constant CHILDREN indicates that a DocumentStructureRetrieve is to return only the child nodes of a section, not any further descendants

COLLECTION - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

COLLECTIONNAME - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

COLON - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

COMMA - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

connectionRefusedMessage - Static variable in exception org.greenstone.fedora.services.FedoraGS3Exception

Constant string message to display when a connection is refused

containsSectionNumber(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

For finding out if the sectionNumber is given as part of the docID.

convertToMetaNumber(String) - Method in class org.greenstone.fedora.services.FedoraConnection

Given a number of the form x(.y.z), this method returns this number as is, except when x = 1, in which case, it would return .y.z That is, given number=3.2.1, this method would return 3.2.1 But, given number=1.2.3, this method would return .2.3.

createAPIA(FedoraAPIAServiceLocator, String, String, boolean) - Method in class org.greenstone.fedora.services.FedoraConnection

Tries to create the FedoraAPIA instance using the serviceLocator and the given portSuffix.

createClassifierElement(Document, String, int, String, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

createDocNodeFromSubsection(Document, Element, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Given a particular subsection element, this method creates a Greenstone3 DocumentNode element that mirrors it.

createDocStructure(Document, Element, Element, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Recursive method that creates a documentStructure mirroring parameter section, starting from parameter parent down to all descendants

createNameValuePairElement(Document, String, String, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

createResponseMessage(Document, Element, Exception, String, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Here we create the greenstone's response message element: <message≶<response><content></response></message>

createServiceList(Document) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

D

DC - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

Fedora's Dublin Core metadata

DC_TITLE_FIELD - Static variable in class org.greenstone.fedora.services.GSearchConnection

defaultPortAddressSuffix - Static variable in class org.greenstone.fedora.services.FedoraConnection

The part of the portAddress that comes after the baseURL.

DESCENDANTS - Static variable in class org.greenstone.fedora.services.FedoraGS3Connection

constant DESCENDANTS indicates that a DocumentStructureRetrieve is to return all descendants of a section

describeCollection(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

describeCollection(String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

describeCollectionService(String, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

describeCollectionService(String, String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

All collections in this Digital Library (Fedora Repository) share the same services, so this method returns the same as describeService(serviceName).

describeCollectionServices(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

describeCollectionServices(String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

describeFieldQueryService(Element) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Appends children to the parameter service Element that make the final service Element into a describe response XML for FedoraGS3's FieldQuery service.

describeService(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

All collections in this Digital Library (Fedora Repository) share the same services, so this method returns the same as describeCollectionService(collName, serviceName).

describeService(String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

All collections in this Digital Library (Fedora Repository) share the same services, so this method returns the same as describeCollectionService(collName, serviceName).

describeTextQueryService(Element) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Appends children to the parameter service Element that make the final service Element into a describe response XML for FedoraGS3's TextQuery service.

DLS - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

DLS metadata of Greenstone documents - this metadata set is optionally provided for top level documents.

DOC_TITLES - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

E

elementToFormattedString(Element) - Static method in class org.greenstone.fedora.services.FedoraCommons

Given an Element, this will return its String representation properly indented for display.

elementToString(Element) - Static method in class org.greenstone.fedora.services.FedoraCommons

Given an Element, this will return its String representation without indenting it for display.

ENGLISH - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

EX - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

EX marks the XML metadata file that contains Greenstone extracted metadata

F

FEDORA_GS3 - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

Instead of message router, we indicate that request messages sent here come from FedoraGS3

FedoraCommons - Class in org.greenstone.fedora.services

Methods common to both Fedora(GS3)Connection and GSearchConnection.

FedoraCommons() - Constructor for class org.greenstone.fedora.services.FedoraCommons

FedoraConnection - Class in org.greenstone.fedora.services

Class that establishes a connection with Fedora's web services (via Java stub classes for the same) and then provides methods to retrieve Greenstone-specific data, such as the TOC, EX, DC,and Section datastreams of the Greenstone documents stored in Fedora's repository.

FedoraConnection(String, String, int, String, String) - Constructor for class org.greenstone.fedora.services.FedoraConnection

Code for this constructor is from DemoSOAPClient.java.

FedoraConnection() - Constructor for class org.greenstone.fedora.services.FedoraConnection

Default constructor which takes input from the user to get host, port, fedora username and password.

FedoraConnection(File) - Constructor for class org.greenstone.fedora.services.FedoraConnection

Single argument constructor that takes the name of the properties file defining the values of the initialisation parameters required to instantiate a FedoraConnection.

FedoraGS3Connection - Class in org.greenstone.fedora.services

Class that extends FedoraConnection in order to be able to use Fedora's web services to retrieve the specific datastreams of Greenstone documents stored in Fedora's repository.

FedoraGS3Connection(String, String, int, String, String) - Constructor for class org.greenstone.fedora.services.FedoraGS3Connection

5 argument constructor is the same as that of superclass FedoraConnection:

FedoraGS3Connection() - Constructor for class org.greenstone.fedora.services.FedoraGS3Connection

No-argument constructor which is the same as that of superclass FedoraConnection: it displays a small dialog requesting input for the host, port, administrative password and username of the fedora server.

FedoraGS3Connection(File) - Constructor for class org.greenstone.fedora.services.FedoraGS3Connection

Single-argument constructor which is the same as that of superclass FedoraConnection: it takes the name of the properties file where connection initialisation values may already be provided and then displays a small dialog requesting input for the host, port, administrative password and username of the fedora server showing the values in the properties file as default.

FedoraGS3DL - Interface in org.greenstone.fedora.services

Defines the methods that must be provided to retrieve the datastreams specific to Greenstone documents stored in a Fedora repository.

FedoraGS3Exception - Exception in org.greenstone.fedora.services

The exceptions that can be thrown by FedoraGS3.

FedoraGS3Exception() - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception

No argument constructor merely sets the message to this class' name.

FedoraGS3Exception(String) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception

Constructs a FedoraGS3Exception with the given message.

FedoraGS3Exception(String, Throwable) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception

Constructs a FedoraGS3Exception with the given message and cause.

FedoraGS3Exception(Throwable) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception

Constructs a FedoraGS3Exception with the given cause.

FedoraGS3Exception.AuthenticationFailedException - Exception in org.greenstone.fedora.services

This AuthenticationFailedException can be thrown when the user enters an invalid username and password into the FedoraConnection Authentication popup dialog (displayed upon FedoraConnection object construction).

FedoraGS3Exception.AuthenticationFailedException() - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.AuthenticationFailedException

FedoraGS3Exception.CancelledException - Exception in org.greenstone.fedora.services

When the user chooses to cancel out of the FedoraConnection dialog of the constructor (where they have to enter authentication information), this exception is thrown, so that classes making use of FedoraConnection may choose whether to exit their program or deal with it differently.

FedoraGS3Exception.CancelledException() - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.CancelledException

FedoraGS3Exception.FedoraGS3InitFailureException - Exception in org.greenstone.fedora.services

Static inner class FedoraGS3InitFailureException is an Exception that is thrown when no connection can be made to the Fedora server and therefore the FedoraGS3 object construction failed.

FedoraGS3Exception.FedoraGS3InitFailureException() - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3InitFailureException

FedoraGS3Exception.FedoraGS3InitFailureException(String) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3InitFailureException

FedoraGS3Exception.FedoraGS3InitFailureException(String, Throwable) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3InitFailureException

FedoraGS3Exception.FedoraGS3InitFailureException(Throwable) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3InitFailureException

FedoraGS3Exception.FedoraGS3RunException - Exception in org.greenstone.fedora.services

Represents an exception that occurs when FedoraGS3 is running A subclass of FedoraGS3Exception

FedoraGS3Exception.FedoraGS3RunException() - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3RunException

FedoraGS3Exception.FedoraGS3RunException(String) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3RunException

FedoraGS3Exception.FedoraGS3RunException(String, Throwable) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3RunException

FedoraGS3Exception.FedoraGS3RunException(Throwable) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3RunException

FedoraGS3Exception.FedoraVersionNotSupportedException - Exception in org.greenstone.fedora.services

Certain functionality in Fedora - in particular fielded search - is implemented differently or uses slightly different Fedora types in older versions of Fedora (fielded search in 2.0 uses a different Condition class).

FedoraGS3Exception.FedoraVersionNotSupportedException(String) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraVersionNotSupportedException

FedoraGS3Exception.NotAFedoraServerException - Exception in org.greenstone.fedora.services

This AuthenticationFailedException can be thrown when there is some server listening at the host and port values entered by the user, but when this server is (most likely) not a Fedora Server.

FedoraGS3Exception.NotAFedoraServerException() - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.NotAFedoraServerException

FedoraGS3Exception.NotAFedoraServerException(String) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.NotAFedoraServerException

FedoraGS3Exception.ServerNotFoundException - Exception in org.greenstone.fedora.services

This ServerNotFoundException can be thrown when the user enters there is no (Fedora) server listening at a given host and port.

FedoraGS3Exception.ServerNotFoundException(String) - Constructor for exception org.greenstone.fedora.services.FedoraGS3Exception.ServerNotFoundException

fedoraGSearch - Variable in class org.greenstone.fedora.services.FedoraGS3Connection

The object used to connect to FedoraGenericSearch, which is used for doing full-text searching

FedoraToGS3Interface - Interface in org.greenstone.fedora.services

Most of the following methods return the same data as FedoraGS3DL, but formatted as Greenstone Response-Message XML.

FedoraToGS3Interface.Constants - Interface in org.greenstone.fedora.services

Interface declaring some string constants of literals to look for

fedoraVersion - Variable in class org.greenstone.fedora.services.FedoraConnection

Version of the running fedora server

FIELD - Static variable in class org.greenstone.fedora.services.GSearchConnection

FIELDNAME_ATT - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

fieldQuery(String, Map, int) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

This method performs a fieldquery, searching for x number of phrases in each of the 4 indexed fields.

findObjectsWithTitlesContaining(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

formatSearchTermsInField(String, String) - Method in class org.greenstone.fedora.services.GSearchConnection

Each field is a comma separated list of terms that may be either a word OR a phrase.

FULLTEXT - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

FULLTEXT_FIELD - Static variable in class org.greenstone.fedora.services.GSearchConnection

G

G_FIND_OBJECTS - Static variable in class org.greenstone.fedora.services.GSearchConnection

The names of the methods we use of Fedora Generic Search's web services are declared here as static final Strings.

GET - Static variable in class org.greenstone.fedora.services.FedoraConnection

getAssocFileBaseURL() - Method in class org.greenstone.fedora.services.FedoraConnection

getAssocFileBaseURL() - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getBaseURL() - Method in class org.greenstone.fedora.services.FedoraConnection

getBaseURL() - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getChildren(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

getChildren(String[]) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

getChildren(String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

getChildren(String[]) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

getChildrenOfSection(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

getChildrenOfSection(String, String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getChildrenOfSectionXML(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

getChildrenOfSectionXML(String, String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getCollectionDocs(String) - Method in class org.greenstone.fedora.services.FedoraConnection

Searches the fedora repository for all greenstone:<colPID>* and returns the PIDs of the data objects found, with the exception of greenstone:<colPID>-collection, which is not a document but a collection PID.

getCollectionDocs(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getCollectionList() - Method in class org.greenstone.fedora.services.FedoraGS3Connection

getCollectionList() - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

getCollectionMetadata(String[]) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Given a list of collectionIDs, returns a GS3 DocumentMetadataRetrieve response message that gives the metadata for each collection identified

getCollectionMetadata(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Given a collectionID, returns a GS3 DocumentMetadataRetrieve response message that gives the metadata for the collection identified

getCollectionMetadata(String[]) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

Given a list of collectionIDs, returns a GS3 DocumentMetadataRetrieve response message that gives the metadata for each collection identified

getCollectionMetadata(String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

Given a collectionID, returns a GS3 DocumentMetadataRetrieve response message that gives the metadata for the collection identified

getCollectionName(String) - Method in class org.greenstone.fedora.services.FedoraConnection

getCollectionName(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getCollectionNames(String[]) - Method in class org.greenstone.fedora.services.FedoraConnection

getCollectionNames(String[]) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getCollectionPID(String) - Method in class org.greenstone.fedora.services.FedoraConnection

getCollectionPID(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getCollectionPIDs(String[]) - Method in class org.greenstone.fedora.services.FedoraConnection

getCollectionPIDs(String[]) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getCollections() - Method in class org.greenstone.fedora.services.FedoraConnection

Gets all greenstone collections.

getCollections() - Method in interface org.greenstone.fedora.services.FedoraGS3DL

Gets all greenstone collections.

getCollectionTitle(String) - Method in class org.greenstone.fedora.services.FedoraConnection

Gets the title of the collection denoted by the given collection's pid by retrieving the title metadata for it from the collection's EX datastream.

getCollectionTitle(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

Gets the title of the collection denoted by the given collection's pid by retrieving the title metadata for it from the collection's EX datastream.

getCollectionTitles(String[]) - Method in class org.greenstone.fedora.services.FedoraConnection

getCollectionTitles(String[]) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getContent(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Given an identifier that is either a docPID or a concatenation of docPID+sectionID, this method works out the fedora assigned docPID and sectionID and then calls getContentBody(docPID, sectionID) with those.

getContent(String[]) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Given an identifier that is a concatenation of docID+sectionID, this method works out the fedora assigned docPID and sectionID and then calls getContentBody(docPID, sectionID) with those.

getContent(String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

Given a list of document identifiers that are either docPIDs or concatenations of docPID+sectionID, this method retrieves their contents.

getContent(String[]) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

Given a document identifier that is either a docPID or a concatenation of docPID+sectionID, this method retrieves the content for it.

getContentBody(String, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Gets the contents of a textNode from a section.

getDC(String) - Method in class org.greenstone.fedora.services.FedoraConnection

All objects (incl "greenstone:*" objects) in fedora - be they collections, top-level documents or document sections - have a DC datastream.

getDC(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

All objects (incl "greenstone:*" objects) in fedora - be they collections, top-level documents or document sections) have an EX datastream.

getDLS(String) - Method in class org.greenstone.fedora.services.FedoraConnection

Some "greenstone:*" top-level documents in the fedora repository (but not greenstone collections or document sections) have a DLS metadata datastream.

getDLS(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

Some "greenstone:*" top-level documents in the fedora repository (but not greenstone collections or document sections) have a DLS metadata datastream.

getDocName(String) - Method in class org.greenstone.fedora.services.FedoraConnection

getDocName(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getDocPIDFromDocID(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

This method will extract the docPID from docID and return it.

getDocTitle(String) - Method in class org.greenstone.fedora.services.FedoraConnection

Gets the title metadata for a particular doc object in a collection denoted by docPID.

getDocTitle(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

Gets the title metadata for a particular doc object in a collection denoted by docPID.

getDocTitles(String[]) - Method in class org.greenstone.fedora.services.FedoraConnection

getDocTitles(String[]) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getDocumentMetadata(String[]) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Given a list of document identifiers, a GS3 DocumentMetadataRetrieve response message is returned containing the metadata for each document.

getDocumentMetadata(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Given a document identifier, returns a GS3 DocumentMetadataRetrieve response message containing the metadata for the document.

getDocumentMetadata(String[]) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

Given a list of document identifiers, a GS3 DocumentMetadataRetrieve response message is returned containing the metadata for each document.

getDocumentMetadata(String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

Given a document identifier, returns a GS3 DocumentMetadataRetrieve response message containing the metadata for the document.

getDocumentStructure(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

getDocumentStructure(String[]) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

getDocumentStructure(String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

getDocumentStructure(String[]) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

getEX(String) - Method in class org.greenstone.fedora.services.FedoraConnection

All "greenstone:*" objects in fedora (be they collections be they collections, top-level documents or document sections) have an EX datastream.

getEX(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

All "greenstone:*" objects in fedora (be they collections, top-level documents or document sections) have an EX datastream.

getFedoraVersion() - Method in class org.greenstone.fedora.services.FedoraConnection

The version of the running Fedora server, which may or may not match the supported version.

getGSearchIndexName() - Method in class org.greenstone.fedora.services.FedoraGS3Connection

getGSearchIndexName() - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

getGSearchWSDLURL() - Method in class org.greenstone.fedora.services.FedoraGS3Connection

getGSearchWSDLURL() - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

getItem(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

Return a datastream of a document, given the document's id and the item id of the datastream which is to be retrieved.

getLanguage() - Method in class org.greenstone.fedora.services.FedoraConnection

getLanguage() - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getMaxResults() - Method in class org.greenstone.fedora.services.FedoraConnection

The default maximum number of search results returned for a search.

getMaxResults() - Method in interface org.greenstone.fedora.services.FedoraGS3DL

The default maximum number of search results returned for a search.

getMessage() - Method in exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3RunException

Overloading getMessage() to return some details as to what exactly went wrong.

getMetadata(String[]) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

getMetadata(Document, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Method that takes a new DOM document, as well as an identifier of either a collection or document (which may be a fedora pid for the collection or document, or may be the documentPid-sectionNumber for a document) and returns a documentNode element for it: <documentNode><metadataList> <metadata name="">value</metadata> ...

getMetadata(String[]) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

getPIDsFromSearchResult(String, String) - Method in class org.greenstone.fedora.services.GSearchConnection

Call this method with the return value of calling search().

getPortAddressURL() - Method in class org.greenstone.fedora.services.FedoraConnection

getPortAddressURL() - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getResponseAsDOM(DocumentBuilder, String) - Static method in class org.greenstone.fedora.services.FedoraCommons

Turns the XML String into a DOM tree and returns it.

getSection(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

getSection(String, String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getSectionDCMetadata(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

getSectionDCMetadata(String, String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getSectionEXMetadata(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

Returns the section EX metadata XML datastream for SectionID which may be a section name or number.

getSectionEXMetadata(String, String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getSectionIDFromDocID(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

This method will return the section Number, if there's any suffixed to the docID.

getSectionNames(String) - Method in class org.greenstone.fedora.services.FedoraConnection

Given the pid of a document fedora data object, this method will return all itemIDs that are part of that data object and are Sections.

getSectionNames(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

Given the pid of a document fedora data object, this method will return all itemIDs that are part of that data object and are Sections.

getSectionNumbers(String) - Method in class org.greenstone.fedora.services.FedoraConnection

Given the pid of a document fedora data object, this method will return all itemIDs that are part of that data object and are Sections, but just the Section numbers are returned.

getSectionNumbers(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

Given the pid of a document fedora data object, this method will return all itemIDs that are part of that data object and are Sections, but just the Section numbers are returned.

getSectionTitle(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

getSectionTitle(String, String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getSectionTitles(String[], String[]) - Method in class org.greenstone.fedora.services.FedoraConnection

getSectionTitles(String[], String[]) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getServiceList() - Method in class org.greenstone.fedora.services.FedoraGS3Connection

getServiceList() - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

getServiceNames() - Method in class org.greenstone.fedora.services.FedoraGS3Connection

getStructure(String[], int) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Returns a greenstone3 DocumentStructureRetrieve XML response message containing the document structures for the given docIDs.

getStructure(Document, String, String, Element) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Takes the portion of the XML document outlining the structure of the document (section)--in the format this is stored in Fedora--and returns Greenstone 3 DOM XML format for outlining document structure.

getStructureElement(Element, String[], int) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Given a <documentNodeList> portion of a greenstone3 DocumentStructureRetrieve XML response message, this method will populate it with the <documentNodes> that represent the structure of the given docIDs.

getSubsection(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

getSubsection(String, String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getSubsectionXML(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

getSubsectionXML(String, String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getSubstructure(Element, boolean) - Method in class org.greenstone.fedora.services.FedoraConnection

Convert the given Element to a String representing the same XML.

getSupportedVersion() - Static method in class org.greenstone.fedora.services.FedoraConnection

Static method that returns the version of Fedora supported by this class FedoraConnection.

getTitle(String) - Method in class org.greenstone.fedora.services.FedoraConnection

Given a string representation of a document's or document section's EX datastream -- which is a greenstone extracted metadata XML file -- of the form: <ex> <ex:metadata name="Title">sometitle</ex:metadata> <ex:metadata name="...">....</ex:metadata> ...

getTitle(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

getTitle(String, String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getTitleMetadata(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Given a document identifier, returns a GS3 DocumentMetadataRetrieve response message containing ONLY the Title metadata for the document.

getTitleMetadata(String[]) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Given a document identifier, returns a GS3 DocumentMetadataRetrieve response message containing ONLY the Title metadata for the documents.

getTitleMetadata(Document, String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Method that takes a new DOM document, as well as an identifier of either a document or document section and returns a documentNode element containing the title metadata for it: <documentNode nodeID="docID"><metadataList> <metadata name="Title">sometitle</metadata> </metadataList></documentNode>

getTitleMetadata(String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

Given a document identifier, returns a GS3 DocumentMetadataRetrieve response message containing ONLY the Title metadata for the document.

getTitleMetadata(String[]) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

Given a document identifier, returns a GS3 DocumentMetadataRetrieve response message containing ONLY the Title metadata for the documents.

getTitles(String, String[]) - Method in class org.greenstone.fedora.services.FedoraConnection

getTitles(String, String[]) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

getTOC(String) - Method in class org.greenstone.fedora.services.FedoraConnection

All "greenstone:*" objects in fedora (be they collections or documents) have a TOC datastream.

getTOC(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

All "greenstone:*" objects in fedora (be they collections or documents) have a TOC datastream.

getValue(Element) - Static method in class org.greenstone.fedora.services.FedoraCommons

Extract the text from an element, if any.

gFindObjects(String, String, int, int, int, int, String, String) - Method in class org.greenstone.fedora.services.GSearchConnection

Method to invoke gfindObjects operation of Fedora Generic Search web services.

GREENSTONE - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

"greenstone" is the FEDORA PID prefix we'll be working with

GREENSTONE_ - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

GS3FilePathMacro - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

GSearchConnection - Class in org.greenstone.fedora.services

Class GSearchConnection connects to FedoraGSearch's web services.

GSearchConnection(String, String) - Constructor for class org.greenstone.fedora.services.GSearchConnection

Constructor that takes a String representing the url of the WSDL file for FedoraGSearch's web services, and tries to establish a connection to those web services.

gSearchIndexName - Variable in class org.greenstone.fedora.services.FedoraGS3Connection

The name of the index that FedoraGSearch will index the GS3 documents into.

gSearchWSDLSuffix - Static variable in class org.greenstone.fedora.services.FedoraGS3Connection

The last part of the gSearchWSDL URL.

gSearchWSDLURL - Variable in class org.greenstone.fedora.services.FedoraGS3Connection

The url for the wsdl file of FedoraGSearch's web services by default this will be the Fedora server's base URL concatenated to "gsearch/services/FgsOperations?wsdl"

H

HIT_TOTAL - Static variable in class org.greenstone.fedora.services.GSearchConnection

HYPHEN - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

I

ID - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

indexName - Variable in class org.greenstone.fedora.services.GSearchConnection

The name of the Index wherein FedoraGSearch has indexed all the GS3 docs.

init(String, String, String, String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

Init method that is called by the constructor to set some important member variables including instantiating the APIA object used to invoke the Fedora APIA web service operations.

initSearchFunctionality() - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Init method that instantiates a GSearchConnection object used to work with the separate FedoraGSearch web services.

INTERNAL_NODE - Static variable in class org.greenstone.fedora.services.FedoraConnection

L

lang - Variable in class org.greenstone.fedora.services.FedoraConnection

The preferred language of the displat content

M

main(String[]) - Static method in class org.greenstone.fedora.services.FedoraConnection

main(String[]) - Static method in class org.greenstone.fedora.services.FedoraGS3Connection

main(String[]) - Static method in class org.greenstone.fedora.services.GSearchConnection

MAXDOCS - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

names of query form controls

maxresults - Variable in class org.greenstone.fedora.services.FedoraConnection

The maximum number of collections to retrieve

MESSAGE - Static variable in exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3InitFailureException

MESSAGE - Static variable in exception org.greenstone.fedora.services.FedoraGS3Exception.NotAFedoraServerException

METADATA - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

missingTargetService - Static variable in exception org.greenstone.fedora.services.FedoraGS3Exception

Constant string message to check against if "AXIS engine could not find a target service to invoke" message is the cause for an AxisFault exception embedded in a RemoteException

N

NAME - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

NAME - Static variable in class org.greenstone.fedora.services.GSearchConnection

NAMESPACE_URI - Static variable in class org.greenstone.fedora.services.GSearchConnection

NUM_DOCS_MATCHED - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

O

OBJECT - Static variable in class org.greenstone.fedora.services.GSearchConnection

OCCURS_ATT - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

org.greenstone.fedora.services - package org.greenstone.fedora.services

P

PERIOD - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

PID - Static variable in class org.greenstone.fedora.services.GSearchConnection

portAddressSuffix - Variable in class org.greenstone.fedora.services.FedoraConnection

The user-specified portAddressSuffix of the Fedora Access web services (endpoint URL in the WSDL), usually of the form http://localhost:8080/fedora/services/access Users can tell FedoraGS3 to try accessing that first by setting the "port.address.suffix" property in the properties file.

portName - Variable in class org.greenstone.fedora.services.GSearchConnection

The portName object used when connecting to FedoraGSearch's web services

Q

QUALIFIER - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

query(String, String, Map) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

QUERY - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

query(String, String, Map) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

R

removePrefix(String, String) - Method in class org.greenstone.fedora.services.FedoraConnection

Given something like str="SECTION1.2.1" and prefix="SECTION" this method returns "1.2.1".

S

search(String, String, int, int, int) - Method in class org.greenstone.fedora.services.GSearchConnection

Method that performs a search for the given searchTerm inside the given indexed field.

search(Map, int, int) - Method in class org.greenstone.fedora.services.GSearchConnection

FedoraGSearch accepts a query of the form: <"cyclone val" "Gender Inequalities" ds.fulltext:"cyclone val" ds.fulltext:"worst storm"> where the first two phrases are searched for in all indexed fields, (in this case dc.title and ds.fulltext), while the last two are searched for in the ds.fulltext field.

search(String, int, int, int) - Method in class org.greenstone.fedora.services.GSearchConnection

Uses FedoraGSearch to perform a search where the query is embedded in fieldedSearchTerms, which not only provides the terms to search on, but also the fields to search the (various) given terms in.

searchDocumentTitles(String, String, boolean) - Method in class org.greenstone.fedora.services.FedoraConnection

Implements querying document DC titles of a greenstone collection stored in the fedora repository for a term that may occur anywhere in their titles.

searchDocumentTitles(String, String, boolean) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

Allows querying document titles of a greenstone collection stored in the fedora repository for a term that may occur anywhere in their titles.

SECTION - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

The SECTION prefix in the name of a section's datastream; eg.

SECTION_ELEMENT - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

service - Variable in class org.greenstone.fedora.services.GSearchConnection

The Service object used to connect to the FedoraGSearch web services

SERVICE_NAME - Static variable in class org.greenstone.fedora.services.GSearchConnection

serviceNames - Variable in class org.greenstone.fedora.services.FedoraGS3Connection

List of services actually supported by our FedoraGS3 repository after construction.

SERVICES - Static variable in class org.greenstone.fedora.services.FedoraGS3Connection

Complete list of services that are supported our FedoraGS3 would support if everything goes well.

setGSearchIndexName(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Sets the member variable gSearchIndexName that specifies the name of the index containing indexed GS3 documents.

setGSearchIndexName(String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

Sets the member variable gSearchIndexName that specifies the name of the index containing indexed GS3 documents.

setGSearchWSDLURL(String) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

Sets the member variable gSearchWSDLURL that specify the location of the WSDL file of FedoraGSearch's web services.

setGSearchWSDLURL(String) - Method in interface org.greenstone.fedora.services.FedoraToGS3Interface

Sets the member variable gSearchWSDLURL that specify the location of the WSDL file of FedoraGSearch's web services.

setInitialisationProperties(Properties) - Method in class org.greenstone.fedora.services.FedoraConnection

Method that loops to display the dialog that retrieves the fedora server initialisation properties from the user.

setInitialisationProperties(Properties) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

The superclass constructor calls this method passing any preset properties loaded from a propertiesFile.

setLanguage(String) - Method in class org.greenstone.fedora.services.FedoraConnection

Sets the the default language used to query for titles (and anything else where there are multiple language options).

setLanguage(String) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

Sets the the default language used to query for titles (and anything else where there are multiple language options).

setMaxResults(int) - Method in class org.greenstone.fedora.services.FedoraConnection

Set the default maximum number of search results returned for a search.

setMaxResults(int) - Method in interface org.greenstone.fedora.services.FedoraGS3DL

Set the default maximum number of search results returned for a search.

setSpecifics(String) - Method in exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3RunException

showAuthenticationPopup(Properties) - Static method in class org.greenstone.fedora.services.FedoraConnection

Static method that displays a popup to allow the user to provide Fedora authentication (username, pwd) and connection (protocol+host, port) details.

SIMPLEFIELD_ATT - Static variable in interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants

SPACE - Static variable in class org.greenstone.fedora.services.GSearchConnection

separator used internally to separate values of a search field

specifics - Variable in exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3RunException

Some extra information as to what when wrong

sslHandshakeExceptionMessage - Static variable in exception org.greenstone.fedora.services.FedoraGS3Exception

Constant string message to display if the sslHandshake fails when trying to connect to Fedora using https

SUPPORTED_VERSION - Static variable in class org.greenstone.fedora.services.FedoraConnection

The version of fedora that is supported by class FedoraConnection

T

textQuery(String, String, int) - Method in class org.greenstone.fedora.services.FedoraGS3Connection

TITLE - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

TOC - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

Table of contents for a Greenstone-Fedora document which outlines the structure of the document.

TYPE - Static variable in class org.greenstone.fedora.services.FedoraConnection

U

UTF8 - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

W

WILDCARD - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

X

xmlToStringConversionFailureResponseMsg - Static variable in exception org.greenstone.fedora.services.FedoraGS3Exception.FedoraGS3RunException

If a problem occurs converting the error message into XML this string is created in the format of XML stating the problem that occurred when trying to convert XML to String.

_

_COLLECTION - Static variable in interface org.greenstone.fedora.services.FedoraGS3DL

A B C D E F G H I L M N O P Q R S T U W X _