net.yacy.document.importer

Class ResumptionToken

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<java.lang.String,java.lang.String>

net.yacy.document.importer.ResumptionToken

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.String>, java.util.NavigableMap<java.lang.String,java.lang.String>, java.util.SortedMap<java.lang.String,java.lang.String>

public class ResumptionToken
extends java.util.TreeMap<java.lang.String,java.lang.String>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ResumptionToken.Parser

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private static java.text.Collator	insensitiveCollator
private int	recordCounter
private static long	serialVersionUID
private DigestURL	source
private static java.lang.ThreadLocal<javax.xml.parsers.SAXParser>	tlSax

Constructor Summary

Constructors

Constructor and Description
ResumptionToken(DigestURL source, byte[] b)

Method Summary

Methods

Modifier and Type	Method and Description
private java.lang.StringBuilder	escape(java.lang.String s)
int	getCompleteListSize() The completeListSize attribute provides a place where the estimated number of results in the complete list response may be announced.
int	getCursor() The cursor attribute is the number of results returned so far in the complete list response, thus it is always "0" in the first incomplete list response.
java.util.Date	getExpirationDate() an expiration date of a resumption token that addresses how long a cached set will stay in the cache of the oai-pmh server.
private static javax.xml.parsers.SAXParser	getParser()
int	getRecordCounter() while parsing the resumption token, also all records are counted
java.lang.String	getToken() get a token of the stateless transfer in case that no expiration date is given see: http://www.openarchives.org/OAI/2.0/guidelines-repository.htm#StateInResumptionToken
DigestURL	resumptionURL() compute a url that can be used to resume the retrieval from the OAI-PMH resource
java.lang.String	toString()
static java.lang.String	truncatedURL(DigestURL url) truncate the given url at the '?'

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

insensitiveCollator

private static final java.text.Collator insensitiveCollator

recordCounter

private int recordCounter

source

private final DigestURL source

tlSax

private static final java.lang.ThreadLocal<javax.xml.parsers.SAXParser> tlSax

Constructor Detail

ResumptionToken

public ResumptionToken(DigestURL source,
               byte[] b)
                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

truncatedURL

public static java.lang.String truncatedURL(DigestURL url)

truncate the given url at the '?'

Parameters:

url -

Returns:

a string containing the url up to and including the '?'

getRecordCounter

public int getRecordCounter()

while parsing the resumption token, also all records are counted

Returns:

the result from counting the records

resumptionURL

public DigestURL resumptionURL()
                        throws java.io.IOException

compute a url that can be used to resume the retrieval from the OAI-PMH resource

Parameters:

givenURL -

Returns:

Throws:

java.io.IOException - in case that no follow-up url can be generated; i.e. if the expiration date is exceeded

escape

private java.lang.StringBuilder escape(java.lang.String s)

getExpirationDate

public java.util.Date getExpirationDate()

an expiration date of a resumption token that addresses how long a cached set will stay in the cache of the oai-pmh server. See: http://www.openarchives.org/OAI/2.0/guidelines-repository.htm#CachedResultSet

Returns:

getCompleteListSize

public int getCompleteListSize()

The completeListSize attribute provides a place where the estimated number of results in the complete list response may be announced. This is likely to be used for status monitoring by harvesting software and implementation is recommended especially in repositories with large numbers of records. The value of completeListSize can be reliably accurate only in the case of a system where the result set is cached. In other cases, it is permissible for repositories to revise the estimate during a list request sequence. An attribute according to http://www.openarchives.org/OAI/2.0/guidelines-repository.htm#completeListSize

Returns:

getCursor

public int getCursor()

The cursor attribute is the number of results returned so far in the complete list response, thus it is always "0" in the first incomplete list response. It should only be specified if it is consistently used in all responses. An attribute according to http://www.openarchives.org/OAI/2.0/guidelines-repository.htm#completeListSize

Returns:

getToken

public java.lang.String getToken()

get a token of the stateless transfer in case that no expiration date is given see: http://www.openarchives.org/OAI/2.0/guidelines-repository.htm#StateInResumptionToken

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractMap<java.lang.String,java.lang.String>

getParser

private static javax.xml.parsers.SAXParser getParser()
                                              throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException