|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FedoraGS3DL
Defines the methods that must be provided to retrieve the datastreams specific to Greenstone documents stored in a Fedora repository.
Field Summary | |
---|---|
static java.lang.String |
_COLLECTION
|
static java.lang.String |
COLLECTION
|
static java.lang.String |
COLLECTIONNAME
|
static java.lang.String |
COLON
|
static java.lang.String |
DC
Fedora's Dublin Core metadata |
static java.lang.String |
DLS
DLS metadata of Greenstone documents - this metadata set is optionally provided for top level documents. |
static java.lang.String |
ENGLISH
|
static java.lang.String |
EX
EX marks the XML metadata file that contains Greenstone extracted metadata |
static java.lang.String |
FEDORA_GS3
Instead of message router, we indicate that request messages sent here come from FedoraGS3 |
static java.lang.String |
GREENSTONE
"greenstone" is the FEDORA PID prefix we'll be working with |
static java.lang.String |
GREENSTONE_
|
static java.lang.String |
HYPHEN
|
static java.lang.String |
ID
|
static java.lang.String |
METADATA
|
static java.lang.String |
NAME
|
static java.lang.String |
PERIOD
|
static java.lang.String |
QUALIFIER
|
static java.lang.String |
SECTION
The SECTION prefix in the name of a section's datastream; eg. |
static java.lang.String |
SECTION_ELEMENT
|
static java.lang.String |
TITLE
|
static java.lang.String |
TOC
Table of contents for a Greenstone-Fedora document which outlines the structure of the document. |
static java.lang.String |
UTF8
|
static java.lang.String |
WILDCARD
|
Method Summary | |
---|---|
java.lang.String[] |
browseTitlesByLetter(java.lang.String collName,
java.lang.String letter)
Allows browsing document titles of a greenstone collection stored in the fedora repository by letter. |
java.lang.String |
getAssocFileBaseURL()
|
java.lang.String |
getBaseURL()
|
java.lang.String |
getChildrenOfSection(java.lang.String docPID,
java.lang.String sectionID)
|
org.w3c.dom.Element |
getChildrenOfSectionXML(java.lang.String docPID,
java.lang.String sectionID)
|
java.lang.String[] |
getCollectionDocs(java.lang.String colPID)
|
java.lang.String |
getCollectionName(java.lang.String collPID)
|
java.lang.String[] |
getCollectionNames(java.lang.String[] collPIDs)
|
java.lang.String |
getCollectionPID(java.lang.String collName)
|
java.lang.String[] |
getCollectionPIDs(java.lang.String[] collNames)
|
java.lang.String[] |
getCollections()
Gets all greenstone collections. |
java.lang.String |
getCollectionTitle(java.lang.String collPID)
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. |
java.lang.String[] |
getCollectionTitles(java.lang.String[] collPIDs)
|
java.lang.String |
getDC(java.lang.String pid)
All objects (incl "greenstone:*" objects) in fedora - be they collections, top-level documents or document sections) have an EX datastream. |
java.lang.String |
getDLS(java.lang.String pid)
Some "greenstone:*" top-level documents in the fedora repository (but not greenstone collections or document sections) have a DLS metadata datastream. |
java.lang.String |
getDocName(java.lang.String docPID)
|
java.lang.String |
getDocTitle(java.lang.String docPID)
Gets the title metadata for a particular doc object in a collection denoted by docPID. |
java.lang.String[] |
getDocTitles(java.lang.String[] docPIDs)
|
java.lang.String |
getEX(java.lang.String pid)
All "greenstone:*" objects in fedora (be they collections, top-level documents or document sections) have an EX datastream. |
java.lang.String |
getLanguage()
|
int |
getMaxResults()
The default maximum number of search results returned for a search. |
java.lang.String |
getPortAddressURL()
|
java.lang.String |
getSection(java.lang.String docPID,
java.lang.String sectionID)
|
java.lang.String |
getSectionDCMetadata(java.lang.String docPID,
java.lang.String sectionID)
|
java.lang.String |
getSectionEXMetadata(java.lang.String docPID,
java.lang.String sectionID)
|
java.lang.String[] |
getSectionNames(java.lang.String docPID)
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. |
java.lang.String[] |
getSectionNumbers(java.lang.String docPID)
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. |
java.lang.String |
getSectionTitle(java.lang.String docPID,
java.lang.String sectionID)
|
java.lang.String[] |
getSectionTitles(java.lang.String[] docPIDs,
java.lang.String[] sectionIDs)
|
java.lang.String |
getSubsection(java.lang.String docPID,
java.lang.String sectionID)
|
org.w3c.dom.Element |
getSubsectionXML(java.lang.String docPID,
java.lang.String sectionID)
|
java.lang.String |
getTitle(java.lang.String docPID,
java.lang.String sectionID)
|
java.lang.String[] |
getTitles(java.lang.String docPID,
java.lang.String[] sectionIDs)
|
java.lang.String |
getTOC(java.lang.String pid)
All "greenstone:*" objects in fedora (be they collections or documents) have a TOC datastream. |
java.lang.String[] |
searchDocumentTitles(java.lang.String collName,
java.lang.String titleContents,
boolean startsWith)
Allows querying document titles of a greenstone collection stored in the fedora repository for a term that may occur anywhere in their titles. |
void |
setLanguage(java.lang.String lang)
Sets the the default language used to query for titles (and anything else where there are multiple language options). |
void |
setMaxResults(int maxresults)
Set the default maximum number of search results returned for a search. |
Field Detail |
---|
static final java.lang.String FEDORA_GS3
static final java.lang.String GREENSTONE
static final java.lang.String GREENSTONE_
static final java.lang.String COLLECTION
static final java.lang.String _COLLECTION
static final java.lang.String WILDCARD
static final java.lang.String HYPHEN
static final java.lang.String COLON
static final java.lang.String PERIOD
static final java.lang.String UTF8
static final java.lang.String TITLE
static final java.lang.String ID
static final java.lang.String NAME
static final java.lang.String COLLECTIONNAME
static final java.lang.String QUALIFIER
static final java.lang.String ENGLISH
static final java.lang.String METADATA
static final java.lang.String SECTION_ELEMENT
static final java.lang.String EX
static final java.lang.String DC
static final java.lang.String DLS
static final java.lang.String TOC
static final java.lang.String SECTION
Method Detail |
---|
java.lang.String getLanguage()
void setLanguage(java.lang.String lang)
lang
- - the two-letter language code to set the default language to.int getMaxResults()
void setMaxResults(int maxresults)
maxresults
- - the new default maximum number of search results to
be returned.java.lang.String getBaseURL()
java.lang.String getPortAddressURL()
java.lang.String getAssocFileBaseURL()
java.lang.String[] getCollections() throws java.rmi.RemoteException
java.rmi.RemoteException
java.lang.String[] getCollectionNames(java.lang.String[] collPIDs)
collPIDs
- - an array of Strings denoting the pids for greenstone
collections stored in the fedora repositoryl. These should be of the
format "greenstone:<collectionName>-collection".
java.lang.String[] getCollectionPIDs(java.lang.String[] collNames)
collNames
- - a list of names of greenstone collections
stored in the fedora repository.
java.lang.String getCollectionPID(java.lang.String collName)
collName
- - the name of a greenstone collection stored
stored in the fedora repository.
java.lang.String getCollectionTitle(java.lang.String collPID) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException, org.xml.sax.SAXException, java.io.IOException
collPID
- is the pid of a greenstone collection in the fedora
repository.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.xml.sax.SAXException
java.io.IOException
java.lang.String[] getCollectionTitles(java.lang.String[] collPIDs) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException, org.xml.sax.SAXException, java.io.IOException
collPIDs
- - a list of pids identifying greenstone collections
stored in the fedora repository.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.xml.sax.SAXException
java.io.IOException
java.lang.String[] getDocTitles(java.lang.String[] docPIDs) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException, org.xml.sax.SAXException, java.io.IOException
docPIDs
- - a list of pids identifying documents stored in the
fedora repository.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.xml.sax.SAXException
java.io.IOException
java.lang.String getDocTitle(java.lang.String docPID) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException, org.xml.sax.SAXException, java.io.IOException
docPID
- is the pid of the document in the fedora repository
(docPID is of the form greenstone:<colName>-<doc-identifier>
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.xml.sax.SAXException
java.io.IOException
java.lang.String[] getSectionTitles(java.lang.String[] docPIDs, java.lang.String[] sectionIDs) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException, org.xml.sax.SAXException, java.io.IOException
docPIDs
- - a list of pids identifying documents stored in the
fedora repository.sectionIDs
- - a list of sectionIDs identifying individual sections
of documents stored in the fedora repository whose titles are requested.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.xml.sax.SAXException
java.io.IOException
java.lang.String getSectionTitle(java.lang.String docPID, java.lang.String sectionID) throws java.io.UnsupportedEncodingException, java.rmi.RemoteException, org.xml.sax.SAXException, java.io.IOException
docPID
- - a pid identifying a document in the fedora repository.sectionID
- - the sectionID of the section of the
document whose title is requested.
java.io.UnsupportedEncodingException
java.rmi.RemoteException
org.xml.sax.SAXException
java.io.IOException
java.lang.String[] getCollectionDocs(java.lang.String colPID) throws java.rmi.RemoteException
colPID
- is the pid of the greenstone collection stored in
the fedora repository.
java.rmi.RemoteException
java.lang.String[] getSectionNames(java.lang.String docPID) throws java.rmi.RemoteException
docPID
- is a fedora pid identifying a greenstone document object.
java.rmi.RemoteException
java.lang.String[] getSectionNumbers(java.lang.String docPID) throws java.rmi.RemoteException
docPID
- is a fedora pid identifying a greenstone document object.
java.rmi.RemoteException
java.lang.String[] getTitles(java.lang.String docPID, java.lang.String[] sectionIDs) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException, org.xml.sax.SAXException, java.io.IOException
docPID
- is a fedora pid identifying a greenstone document object.sectionIDs
- is a list of identifiers identifying sections in the
document denoted by docPID, whose titles need to be returned. Each
sectionID may sectionID may be either a section name (e.g. SECTION1.5.1)
or a section number (eg. 1.5.1).
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.xml.sax.SAXException
java.io.IOException
java.lang.String getTitle(java.lang.String docPID, java.lang.String sectionID) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException, org.xml.sax.SAXException, java.io.IOException
docPID
- is a fedora pid identifying a greenstone document object.sectionID
- identifies the particular section in the
document denoted by docPID, whose title needs to be returned. The
sectionID may sectionID may be either a section name (e.g. SECTION1.5.1)
or a section number (eg. 1.5.1).
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.xml.sax.SAXException
java.io.IOException
java.lang.String getDocName(java.lang.String docPID)
docPID
- is the pid of a greenstone document in the fedora
repository.
java.lang.String getCollectionName(java.lang.String collPID)
collPID
- is the pid of a greenstone collection in the fedora
repository.
java.lang.String getDC(java.lang.String pid) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException
pid
- - the fedora persistent identifier for an item in the fedora
repository.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
java.lang.String getEX(java.lang.String pid) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException
pid
- - the fedora persistent identifier for an item in the fedora
repository.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
java.lang.String getDLS(java.lang.String pid) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException
pid
- - the fedora persistent identifier for an item in the fedora
repository.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
java.lang.String getTOC(java.lang.String pid) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException
pid
- - the fedora persistent identifier for an item in the fedora
repository.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
java.lang.String getSection(java.lang.String docPID, java.lang.String sectionID) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException
docPID
- is a fedora pid identifying a greenstone document object.sectionID
- identifies the particular section in the
document denoted by docPID, may be a section name or number.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
java.lang.String getSectionDCMetadata(java.lang.String docPID, java.lang.String sectionID) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException
docPID
- is a fedora pid identifying a greenstone document object.sectionID
- identifies the particular section in the
document denoted by docPID, may be a section name or number.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
java.lang.String getSectionEXMetadata(java.lang.String docPID, java.lang.String sectionID) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException
docPID
- is a fedora pid identifying a greenstone document object.sectionID
- identifies the particular section in the
document denoted by docPID, may be a section name or number.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.w3c.dom.Element getChildrenOfSectionXML(java.lang.String docPID, java.lang.String sectionID) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException, org.xml.sax.SAXException, java.io.IOException
docPID
- is a fedora pid identifying a greenstone document object.sectionID
- identifies the particular section in the
document denoted by docPID, may be a section name or number.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.xml.sax.SAXException
java.io.IOException
java.lang.String getChildrenOfSection(java.lang.String docPID, java.lang.String sectionID) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException, org.xml.sax.SAXException, java.io.IOException, javax.xml.transform.TransformerException
docPID
- is a fedora pid identifying a greenstone document object.sectionID
- identifies the particular section in the
document denoted by docPID, may be a section name or number.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.xml.sax.SAXException
java.io.IOException
javax.xml.transform.TransformerException
org.w3c.dom.Element getSubsectionXML(java.lang.String docPID, java.lang.String sectionID) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException, org.xml.sax.SAXException, java.io.IOException
docPID
- is a fedora pid identifying a greenstone document object.sectionID
- identifies the particular section in the
document denoted by docPID, may be a section name or number.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.xml.sax.SAXException
java.io.IOException
java.lang.String getSubsection(java.lang.String docPID, java.lang.String sectionID) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException, org.xml.sax.SAXException, java.io.IOException, javax.xml.transform.TransformerException
docPID
- is a fedora pid identifying a greenstone document object.sectionID
- identifies the particular section in the
document denoted by docPID, may be a section name or number.
java.rmi.RemoteException
java.io.UnsupportedEncodingException
org.xml.sax.SAXException
java.io.IOException
javax.xml.transform.TransformerException
java.lang.String[] browseTitlesByLetter(java.lang.String collName, java.lang.String letter) throws java.rmi.RemoteException, FedoraGS3Exception.FedoraVersionNotSupportedException
letter
- is the starting letter to browse by.
java.rmi.RemoteException
FedoraGS3Exception.FedoraVersionNotSupportedException
java.lang.String[] searchDocumentTitles(java.lang.String collName, java.lang.String titleContents, boolean startsWith) throws java.rmi.RemoteException, FedoraGS3Exception.FedoraVersionNotSupportedException
titleContents
- is the word or phrase to search the collection's
document titles for.startsWith
- - if true, searches for titles that start with
titleContents. Else it searches for titles that contain titleContents.
java.rmi.RemoteException
FedoraGS3Exception.FedoraVersionNotSupportedException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |