eu.dnetlib.data.information.oai.publisher.info

Class ResumptionTokenImpl

java.lang.Object

eu.dnetlib.data.information.oai.publisher.info.ResumptionTokenImpl

All Implemented Interfaces:

ResumptionToken

public class ResumptionTokenImpl
extends Object
implements ResumptionToken

Constructor Summary

Constructors

Constructor and Description
ResumptionTokenImpl()

Method Summary

Modifier and Type	Method and Description
void	deserialize(String token) Deserializes the resumption token and sets the properties of this token accordingly.
String	getLastObjIdentifier() Gets the identifier of the last returned document.
String	getMetadataPrefix() Gets the requested metadata prefix.
int	getnMaxElements() Gets the total number of documents.
int	getnRead() Gets the number of already read records.
String	getQuery() Gets the requested query.
String	getRequestedSet() Gets the requested set.
boolean	hasDateRange()
String	serialize() Serializes the resumption token.
void	setDateRange(boolean hasDateRange)
void	setLastObjIdentifier(String lastObjIdentifier) Sets the identifier of the last returned document.
void	setMetadataPrefix(String metadataPrefix) Sets the requested metadata prefix.
void	setnMaxElements(int nMaxElements) Sets the total number of documents.
void	setnRead(int nRead) Sets the number of already read records.
void	setQuery(String query) Sets the requested query.
void	setRequestedSet(String requestedSet) Sets the requested set.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ResumptionTokenImpl

public ResumptionTokenImpl()

Method Detail

serialize

public String serialize()

Serializes the resumption token.

Specified by:

serialize in interface ResumptionToken

Returns:

a String serialization of this token.

See Also:

ResumptionToken.serialize()

deserialize

public void deserialize(String token)
                 throws BadResumptionTokenException

Deserializes the resumption token and sets the properties of this token accordingly.

Specified by:

deserialize in interface ResumptionToken

Parameters:

token - a String serialization of this token.

Throws:

BadResumptionTokenException

See Also:

ResumptionToken.deserialize(java.lang.String)

getnMaxElements

public int getnMaxElements()

Gets the total number of documents.

Specified by:

getnMaxElements in interface ResumptionToken

Returns:

the total number of documents

See Also:

ResumptionToken.getnMaxElements()

setnMaxElements

public void setnMaxElements(int nMaxElements)

Sets the total number of documents.

Specified by:

setnMaxElements in interface ResumptionToken

Parameters:

nMaxElements - the total number of documents

See Also:

ResumptionToken.setnMaxElements(int)

getMetadataPrefix

public String getMetadataPrefix()

Gets the requested metadata prefix.

Specified by:

getMetadataPrefix in interface ResumptionToken

Returns:

the metadata prefix

See Also:

ResumptionToken.getMetadataPrefix()

setMetadataPrefix

public void setMetadataPrefix(String metadataPrefix)

Sets the requested metadata prefix.

Specified by:

setMetadataPrefix in interface ResumptionToken

See Also:

ResumptionToken.setMetadataPrefix(java.lang.String)

getQuery

public String getQuery()

Gets the requested query.

Specified by:

getQuery in interface ResumptionToken

Returns:

the requested query

See Also:

ResumptionToken.getQuery()

setQuery

public void setQuery(String query)

Sets the requested query.

Specified by:

setQuery in interface ResumptionToken

Parameters:

query - the requested query

See Also:

ResumptionToken.setQuery(java.lang.String)

getnRead

public int getnRead()

Gets the number of already read records.

Specified by:

getnRead in interface ResumptionToken

Returns:

the number of already read records.

See Also:

ResumptionToken.getnRead()

setnRead

public void setnRead(int nRead)

Sets the number of already read records.

Specified by:

setnRead in interface ResumptionToken

Parameters:

nRead - the number of already read records.

See Also:

ResumptionToken.setnRead(int)

getLastObjIdentifier

public String getLastObjIdentifier()

Gets the identifier of the last returned document.

Specified by:

getLastObjIdentifier in interface ResumptionToken

Returns:

the identifier of the last returned document

See Also:

ResumptionToken.getLastObjIdentifier()

setLastObjIdentifier

public void setLastObjIdentifier(String lastObjIdentifier)

Sets the identifier of the last returned document.

Specified by:

setLastObjIdentifier in interface ResumptionToken

Parameters:

lastObjIdentifier - the identifier of the last returned document

See Also:

ResumptionToken.setLastObjIdentifier(java.lang.String)

getRequestedSet

public String getRequestedSet()

Gets the requested set.

Specified by:

getRequestedSet in interface ResumptionToken

Returns:

the requested set

See Also:

ResumptionToken.getRequestedSet()

setRequestedSet

public void setRequestedSet(String requestedSet)

Sets the requested set.

Specified by:

setRequestedSet in interface ResumptionToken

Parameters:

requestedSet - the name of the requested set

See Also:

ResumptionToken.setRequestedSet(java.lang.String)

hasDateRange

public boolean hasDateRange()

Specified by:

hasDateRange in interface ResumptionToken

Returns:

true if the OAI request associated to this ResumptionToken has a date range.

See Also:

ResumptionToken.hasDateRange()

setDateRange

public void setDateRange(boolean hasDateRange)

Specified by:

setDateRange in interface ResumptionToken

See Also:

ResumptionToken.setDateRange(boolean)

toString

public String toString()

Overrides:

toString in class Object