com.exalead.papi.helper

Class SyncedEntry

java.lang.Object

com.exalead.papi.helper.SyncedEntry

public class SyncedEntry
extends java.lang.Object

Description of a synchronized entry as known by the indexing chain. A synchronized entry might represent either:

• a document: can be indexed, being indexed or in error.
• a folder: does not exist in the index but is built automatically from the documents hierarchy (see PushAPI.enumerateSyncedEntries(String, EnumerationMode) for more information about folders)

A synchronized entry description contains the following information:

• uri: the corresponding document unique identifier.
• stamp: the corresponding document stamp (meaningless for folders)
• folder: whether the entry corresponds to a folder or to a document.

Synchronized entries can be enumerated using the synchronized entries enumerator (PushAPI.enumerateSyncedEntries(String, EnumerationMode))

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	folder Whether the entry corresponds to a folder or to a document.
protected SyncedEntriesIterator	parentIterator Parent iterator.
protected java.lang.String	stamp The entry stamp.
protected java.lang.String	uri The entry URI.

Constructor Summary

Constructors

Constructor and Description
SyncedEntry() Basic constructor.
SyncedEntry(java.lang.String uri, java.lang.String stamp, boolean folder, SyncedEntriesIterator parentIterator) Constructor specifying the synchronized entry content and the parent iterator.
SyncedEntry(SyncedEntriesIterator parentIterator) Constructor specifying the parent iterator which generated the entry.

Method Summary

Modifier and Type	Method and Description
SyncedEntriesIterator	getParentIterator() Get a reference to the parent iterator, which generated this synchronized entry.
java.lang.String	getStamp() Gets the value of the stamp for this entry (meaningless for a folder).
java.lang.String	getUri() Gets the URI of this synchronized entry.
boolean	isFolder() Checks whether this entry represents a folder.
protected void	setFolder(boolean folder) Sets the folder property for this entry.
protected void	setStamp(java.lang.String stamp) Sets the value of the stamp for this synchronized entry.
protected void	setUri(java.lang.String uri) Sets the value of the URI for this synchronized entry.

Methods inherited from class java.lang.Object

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

Field Detail

uri

protected java.lang.String uri

The entry URI.

stamp

protected java.lang.String stamp

The entry stamp.

folder

protected boolean folder

Whether the entry corresponds to a folder or to a document.

parentIterator

protected SyncedEntriesIterator parentIterator

Parent iterator.

Constructor Detail

SyncedEntry

public SyncedEntry()

Basic constructor.

SyncedEntry

public SyncedEntry(SyncedEntriesIterator parentIterator)

Constructor specifying the parent iterator which generated the entry.

Parameters:

parentIterator - the parent iterator.

SyncedEntry

public SyncedEntry(java.lang.String uri,
                   java.lang.String stamp,
                   boolean folder,
                   SyncedEntriesIterator parentIterator)

Constructor specifying the synchronized entry content and the parent iterator.

Parameters:

uri - the entry URI

stamp - the entry stamp

folder - whether the entry is a folder or a document

parentIterator - the parent iterator

Method Detail

isFolder

public boolean isFolder()

Checks whether this entry represents a folder.

Returns:

true if this entry is a folder, false otherwise.

setFolder

protected void setFolder(boolean folder)

Sets the folder property for this entry.

Parameters:

folder - true if this entry should be considered as a folder, false otherwise.

getStamp

public java.lang.String getStamp()

Gets the value of the stamp for this entry (meaningless for a folder).

Returns:

the value of the stamp.

setStamp

protected void setStamp(java.lang.String stamp)

Sets the value of the stamp for this synchronized entry.

Parameters:

stamp - the value of the stamp.

getUri

public java.lang.String getUri()

Gets the URI of this synchronized entry.

Returns:

the value of the URI of this synchronized entry.

setUri

protected void setUri(java.lang.String uri)

Sets the value of the URI for this synchronized entry.

Parameters:

uri - the value to set.

getParentIterator

public SyncedEntriesIterator getParentIterator()

Get a reference to the parent iterator, which generated this synchronized entry.

Returns:

the parent iterator.