|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.fcrepo.server.oai.FedoraOAIProvider
public class FedoraOAIProvider
Simple FieldSearch-based OAI provider.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface org.fcrepo.common.Constants |
|---|
Constants.FedoraHome |
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
FedoraOAIProvider(String repositoryName,
String repositoryDomainName,
String localname,
String relpath,
Set adminEmails,
Set friendBaseURLs,
String namespaceID,
long maxSets,
long maxRecords,
long maxHeaders,
FieldSearch fieldSearch)
|
|
| Method Summary | |
|---|---|
Set |
getAdminEmails()
Get the email addresses of administrators of the repository. |
String |
getBaseURL(String protocol,
String port)
Get the HTTP endpoint for the OAI-PMH interface. |
DateGranularitySupport |
getDateGranularitySupport()
Get the finest harvesting granularity supported by the repository. |
DeletedRecordSupport |
getDeletedRecordSupport()
Get the manner in which the repository supports the notion of deleted records. |
Set |
getDescriptions()
Get XML descriptions of the repository. |
Date |
getEarliestDatestamp()
Get a Date (in UTC) that is the guaranteed lower limit of all datestamps recording changes, modifications, or deletions in the repository. |
List |
getHeaders(Date from,
Date until,
String metadataPrefix,
String set)
Just like getRecords, but returns Header objects. |
List |
getHeaders(String resumptionToken)
Get the remaining portion of a set of Headers. |
long |
getMaxHeaders()
Get the maximum number of headers that are returned at a time. |
long |
getMaxRecords()
Get the maximum number of records that are returned at a time. |
long |
getMaxSets()
Get the maximum number of sets that are returned at a time. |
Set |
getMetadataFormats(String id)
Get the MetadataFormats supported across the repository or for an individual item in the repository. |
String |
getProtocolVersion()
Get the version of the OAI-PMH supported by the repository. |
Record |
getRecord(String identifier,
String metadataPrefix)
Get an individual metadata record from the repository. |
List |
getRecords(Date from,
Date until,
String metadataPrefix,
String set)
Get the Records in the repository matching the given criteria. |
List |
getRecords(String resumptionToken)
Get the remaining portion of a set of Records. |
String |
getRepositoryName()
Get a human readable name for the repository. |
List |
getSets()
Get the setSpecs, setNames, and setDescriptions of sets in the repository. |
List |
getSets(String resumptionToken)
Get the remaining portion of a set of Sets. |
Set |
getSupportedCompressionEncodings()
Get the compression encodings supported by the repository. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public FedoraOAIProvider(String repositoryName,
String repositoryDomainName,
String localname,
String relpath,
Set adminEmails,
Set friendBaseURLs,
String namespaceID,
long maxSets,
long maxRecords,
long maxHeaders,
FieldSearch fieldSearch)
| Method Detail |
|---|
public String getRepositoryName()
OAIProvider
getRepositoryName in interface OAIProvider
public String getBaseURL(String protocol,
String port)
OAIProvider
getBaseURL in interface OAIProviderpublic String getProtocolVersion()
OAIProvider
getProtocolVersion in interface OAIProviderpublic Date getEarliestDatestamp()
OAIProvider
getEarliestDatestamp in interface OAIProviderpublic DeletedRecordSupport getDeletedRecordSupport()
OAIProvider
getDeletedRecordSupport in interface OAIProviderpublic DateGranularitySupport getDateGranularitySupport()
OAIProvider
getDateGranularitySupport in interface OAIProviderpublic Set getAdminEmails()
OAIProvider
getAdminEmails in interface OAIProviderpublic Set getSupportedCompressionEncodings()
OAIProvider
getSupportedCompressionEncodings in interface OAIProviderpublic Set getDescriptions()
OAIProvider
getDescriptions in interface OAIProvider
public Record getRecord(String identifier,
String metadataPrefix)
throws CannotDisseminateFormatException,
IDDoesNotExistException,
RepositoryException
OAIProvider
getRecord in interface OAIProvideridentifier - the record identifier.metadataPrefix - the metadata prefix identifier.
CannotDisseminateFormatException
IDDoesNotExistException
RepositoryException - if an error has occurred.
public List getRecords(Date from,
Date until,
String metadataPrefix,
String set)
throws CannotDisseminateFormatException,
NoRecordsMatchException,
NoSetHierarchyException,
RepositoryException
OAIProvider
getRecords in interface OAIProviderfrom - the beginning date of the date range.until - the ending date of the date range.metadataPrefix - the metadata prefix.set - the set of criteria
CannotDisseminateFormatException
NoRecordsMatchException
NoSetHierarchyException
RepositoryException - if an error has occurred.
public List getRecords(String resumptionToken)
throws CannotDisseminateFormatException,
NoRecordsMatchException,
NoSetHierarchyException,
BadResumptionTokenException,
RepositoryException
OAIProvider
getRecords in interface OAIProviderresumptionToken - a string that can be used to get the rest of the list.
CannotDisseminateFormatException
NoRecordsMatchException
NoSetHierarchyException
BadResumptionTokenException
RepositoryException - if an error has occurred.
public List getHeaders(Date from,
Date until,
String metadataPrefix,
String set)
throws CannotDisseminateFormatException,
NoRecordsMatchException,
NoSetHierarchyException,
RepositoryException
OAIProvider
getHeaders in interface OAIProviderfrom - the beginning date range.until - the end of the date range.metadataPrefix - the metadata prefix.set - the set of criteria.
CannotDisseminateFormatException
NoRecordsMatchException
NoSetHierarchyException
RepositoryException - if an error has occurred.
public List getHeaders(String resumptionToken)
throws CannotDisseminateFormatException,
NoRecordsMatchException,
NoSetHierarchyException,
BadResumptionTokenException,
RepositoryException
OAIProvider
getHeaders in interface OAIProviderresumptionToken - a string that can be used to get the rest of the list.
CannotDisseminateFormatException
NoRecordsMatchException
NoSetHierarchyException
BadResumptionTokenException
RepositoryException - if an error has occurred.
public List getSets()
throws NoSetHierarchyException,
RepositoryException
OAIProvider
getSets in interface OAIProviderNoSetHierarchyException
RepositoryException - if an error has occurred.
public List getSets(String resumptionToken)
throws BadResumptionTokenException,
NoSetHierarchyException,
RepositoryException
OAIProvider
getSets in interface OAIProviderresumptionToken - a string that can be used to get the rest of the list.
BadResumptionTokenException
NoSetHierarchyException
RepositoryException - if an error has occurred.
public Set getMetadataFormats(String id)
throws NoMetadataFormatsException,
IDDoesNotExistException,
RepositoryException
OAIProvider
getMetadataFormats in interface OAIProviderid - The item identifier, or null, meaning "the entire repository"
NoMetadataFormatsException
IDDoesNotExistException
RepositoryException - if an error has occurred.
public long getMaxSets()
throws RepositoryException
OAIProvider
getMaxSets in interface OAIProviderRepositoryException - if an error has occurred.
public long getMaxRecords()
throws RepositoryException
OAIProvider
getMaxRecords in interface OAIProviderRepositoryException - if an error has occurred.
public long getMaxHeaders()
throws RepositoryException
OAIProvider
getMaxHeaders in interface OAIProviderRepositoryException - if an error has occurred.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||