|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines the essentials of an oai request
Nested Class Summary |
Nested classes inherited from class fr.gouv.culture.oai.OAIObject |
OAIObject.Node |
Field Summary | |
static java.lang.String |
PARAM_NAME_GRANULARITY
|
static java.lang.String |
PARAM_NAME_USE_OAI_LAST_HARVEST_DATE
|
static java.lang.String |
URL_CHARACTER_AMPERSAND
|
static java.lang.String |
URL_CHARACTER_EQUALS
|
static java.lang.String |
URL_CHARACTER_QUESTION_MARK
|
static java.lang.String |
URL_PARAM_NAME_FROM
|
static java.lang.String |
URL_PARAM_NAME_IDENTIFIER
|
static java.lang.String |
URL_PARAM_NAME_METADATA_PREFIX
|
static java.lang.String |
URL_PARAM_NAME_RESUMPTION_TOKEN
|
static java.lang.String |
URL_PARAM_NAME_SET
|
static java.lang.String |
URL_PARAM_NAME_UNTIL
|
static java.lang.String |
URL_PARAM_NAME_VERB
|
static int |
VERB_GET_RECORD
|
static int |
VERB_IDENTIFY
|
static int |
VERB_LIST_IDENTIFIERS
|
static int |
VERB_LIST_METADATA_FORMATS
|
static int |
VERB_LIST_RECORDS
|
static int |
VERB_LIST_SETS
|
static java.lang.String |
VERB_STRING_GET_RECORD
|
static java.lang.String |
VERB_STRING_IDENTIFY
|
static java.lang.String |
VERB_STRING_LIST_IDENTIFIERS
|
static java.lang.String |
VERB_STRING_LIST_METADATA_FORMATS
|
static java.lang.String |
VERB_STRING_LIST_RECORDS
|
static java.lang.String |
VERB_STRING_LIST_SETS
|
static int |
VERB_UNKNOWN
|
static java.lang.String |
verbId
|
Fields inherited from interface fr.gouv.culture.oai.OAIObject |
HTTP_HEADER_NAME_FROM, HTTP_HEADER_NAME_USER_AGENT, NUMBER_RECORDS_PER_RESPONSE, STRING_DATEFORMAT_GRANULARITY_DAY, STRING_DATEFORMAT_GRANULARITY_SECOND |
Method Summary | |
java.lang.String |
getFrom()
Gets the parameter of the request |
java.lang.String |
getGranularity()
Gets the parameter of the request |
java.lang.String |
getIdentifier()
Gets the parameter of the request |
java.lang.String |
getMetadataPrefix()
Gets the parameter of the request |
java.lang.String |
getRepositoryURL()
Gets the repository url of this request |
org.apache.cocoon.environment.Request |
getRequest()
Gets the request |
java.lang.String |
getRequestURL()
Gets the url of this request |
java.lang.String |
getResumptionToken()
Sets the parameters of the request |
java.lang.String |
getSetIdentifier()
Gets the parameter of the request |
java.lang.String |
getUntil()
Gets the parameter of the request |
boolean |
getUseLastHarvestDate()
Gets the parameter of the request |
int |
getVerb()
Gets the verb int value |
java.lang.String |
getVerbId()
Gets the verb int value |
java.lang.String |
getVerbString()
Returns the the verb name |
void |
setFrom(java.lang.String fromDate)
Sets the parameter of the request |
void |
setGranularity(java.lang.String granularity)
Sets the parameter of the request |
void |
setIdentifier(java.lang.String identifier)
Sets the parameter of the request |
void |
setMetadataPrefix(java.lang.String metadataPrefix)
Sets the parameter of the request |
void |
setRepositoryURL(java.lang.String url)
Sets the repository url of this request |
void |
setRequest(org.apache.cocoon.environment.Request coocoonRequest)
Sets the request |
void |
setRequestURL(java.lang.String url)
Sets the url of this request |
void |
setResumptionToken(java.lang.String resumptionToken)
Sets the parameter of the request |
void |
setSetIdentifier(java.lang.String setIdentifier)
Sets the parameter of the request |
void |
setUntil(java.lang.String untilDate)
Sets the parameter of the request |
void |
setUseLastHarvestDate(boolean useLastHarvestDate)
Sets the parameter of the request |
void |
setVerb(int verb)
Sets the verb int value |
void |
setVerbId(java.lang.String verbId)
Sets the verb int value |
void |
setVerbString(java.lang.String verbString)
Set's the the verb name |
void |
toSAX(org.xml.sax.ContentHandler handler,
boolean sendRequestParams)
Sends the appropriate SAX event reprensentation of the request for an oai response to the provide handler |
Methods inherited from interface org.apache.avalon.framework.logger.LogEnabled |
enableLogging |
Methods inherited from interface org.apache.avalon.framework.context.Contextualizable |
contextualize |
Methods inherited from interface org.apache.excalibur.xml.sax.XMLizable |
toSAX |
Methods inherited from interface org.xml.sax.ContentHandler |
characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping |
Methods inherited from interface org.xml.sax.ext.LexicalHandler |
comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity |
Methods inherited from interface org.apache.cocoon.xml.XMLProducer |
setConsumer |
Field Detail |
public static final int VERB_UNKNOWN
public static final int VERB_IDENTIFY
public static final java.lang.String VERB_STRING_IDENTIFY
public static final int VERB_LIST_SETS
public static final java.lang.String VERB_STRING_LIST_SETS
public static final int VERB_LIST_METADATA_FORMATS
public static final java.lang.String VERB_STRING_LIST_METADATA_FORMATS
public static final int VERB_LIST_IDENTIFIERS
public static final java.lang.String VERB_STRING_LIST_IDENTIFIERS
public static final int VERB_LIST_RECORDS
public static final java.lang.String VERB_STRING_LIST_RECORDS
public static final int VERB_GET_RECORD
public static final java.lang.String VERB_STRING_GET_RECORD
public static final java.lang.String verbId
public static final java.lang.String PARAM_NAME_USE_OAI_LAST_HARVEST_DATE
public static final java.lang.String PARAM_NAME_GRANULARITY
public static final java.lang.String URL_CHARACTER_QUESTION_MARK
public static final java.lang.String URL_CHARACTER_AMPERSAND
public static final java.lang.String URL_CHARACTER_EQUALS
public static final java.lang.String URL_PARAM_NAME_VERB
public static final java.lang.String URL_PARAM_NAME_IDENTIFIER
public static final java.lang.String URL_PARAM_NAME_FROM
public static final java.lang.String URL_PARAM_NAME_UNTIL
public static final java.lang.String URL_PARAM_NAME_SET
public static final java.lang.String URL_PARAM_NAME_METADATA_PREFIX
public static final java.lang.String URL_PARAM_NAME_RESUMPTION_TOKEN
Method Detail |
public void setRepositoryURL(java.lang.String url)
public java.lang.String getRepositoryURL()
public void setRequestURL(java.lang.String url)
public java.lang.String getRequestURL()
public void setRequest(org.apache.cocoon.environment.Request coocoonRequest)
public org.apache.cocoon.environment.Request getRequest()
public void setVerb(int verb)
public int getVerb()
public void setVerbId(java.lang.String verbId)
public java.lang.String getVerbId()
public java.lang.String getIdentifier()
public void setIdentifier(java.lang.String identifier)
public java.lang.String getMetadataPrefix()
public void setMetadataPrefix(java.lang.String metadataPrefix)
public boolean getUseLastHarvestDate()
public void setUseLastHarvestDate(boolean useLastHarvestDate)
public java.lang.String getGranularity()
public void setGranularity(java.lang.String granularity)
public java.lang.String getFrom()
public void setFrom(java.lang.String fromDate)
public java.lang.String getUntil()
public void setUntil(java.lang.String untilDate)
public java.lang.String getSetIdentifier()
public void setSetIdentifier(java.lang.String setIdentifier)
public java.lang.String getResumptionToken()
public void setResumptionToken(java.lang.String resumptionToken)
public java.lang.String getVerbString()
public void setVerbString(java.lang.String verbString)
public void toSAX(org.xml.sax.ContentHandler handler, boolean sendRequestParams) throws org.xml.sax.SAXException
handler
- The handler to feedsendRequestParams
- Whether or not the request params should be sent as attributes (according to error state)
org.xml.sax.SAXException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |