org.apache.manifoldcf.crawler.interfaces

Class DocumentVersions

java.lang.Object

org.apache.manifoldcf.crawler.interfaces.DocumentVersions

public class DocumentVersions
extends java.lang.Object

This class represents a set of document versions, organized by document identifier. It's part of the IRepositoryConnector API.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid
protected java.util.Set<java.lang.String>	alwaysRefetch
protected java.util.Map<java.lang.String,VersionContext>	documentVersions

Constructor Summary

Constructors

Constructor and Description
DocumentVersions() Constructor

Method Summary

Modifier and Type	Method and Description
void	alwaysRefetch(java.lang.String documentIdentifier) Signal to always refetch document.
VersionContext	getDocumentVersion(java.lang.String documentIdentifier) Get the document version, if any.
boolean	isAlwaysRefetch(java.lang.String documentIdentifier) Check whether we should always refetch a specified document.
void	setDocumentVersion(java.lang.String documentIdentifier, VersionContext documentVersion) Set a non-special document version.

Methods inherited from class java.lang.Object

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

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

documentVersions

protected final java.util.Map<java.lang.String,VersionContext> documentVersions

alwaysRefetch

protected final java.util.Set<java.lang.String> alwaysRefetch

Constructor Detail

DocumentVersions

public DocumentVersions()

Constructor

Method Detail

setDocumentVersion

public void setDocumentVersion(java.lang.String documentIdentifier,
                               VersionContext documentVersion)

Set a non-special document version.

Parameters:

documentIdentifier - is the document identifier.

documentVersion - is the document version.

alwaysRefetch

public void alwaysRefetch(java.lang.String documentIdentifier)

Signal to always refetch document.

Parameters:

documentIdentifier - is the document identifier.

getDocumentVersion

public VersionContext getDocumentVersion(java.lang.String documentIdentifier)

Get the document version, if any.

Parameters:

documentIdentifier - is the document identifier.

Returns:

the document version, if any. Null indicates that no such document was found.

isAlwaysRefetch

public boolean isAlwaysRefetch(java.lang.String documentIdentifier)

Check whether we should always refetch a specified document.

Parameters:

documentIdentifier - is the document identifier.

Returns:

true if we are directed to always refetch. False will be returned by default.