com.google.enterprise.adaptor

Class DocIdPusher.Record

java.lang.Object

com.google.enterprise.adaptor.DocIdPusher.Record

Enclosing interface:

DocIdPusher

public static final class DocIdPusher.Record
extends Object

Immutable feed attributes for a document identified by its DocId.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocIdPusher.Record.Builder Builder to create instances of Record.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Checks for equality based on all visible fields.
DocId	getDocId() The identifier for the document this record is providing information for.
Date	getLastModified() The last modified date of the document.
Metadata	getMetadata() The Metadata (possibly null) for the document this record is providing information for.
URI	getResultLink() The URI that should be displayed to the user in search results.
int	hashCode() Generates hash code based on all visible fields.
boolean	isToBeCrawledImmediately() Informs the GSA that the document has been modified, and the GSA should give high priority to recrawling the document.
boolean	isToBeCrawledOnce() Informs the GSA that it should only crawl the document once.
boolean	isToBeDeleted() Whether the GSA is being informed the document has been deleted.
boolean	isToBeLocked() Locks the document into the GSA's index.
String	toString() Generates a string representation of this instance useful for debugging that contains all visible fields.

Methods inherited from class java.lang.Object

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

Method Detail

getDocId

public DocId getDocId()

The identifier for the document this record is providing information for.

Returns:

non-null identifier for the document

isToBeDeleted

public boolean isToBeDeleted()

Whether the GSA is being informed the document has been deleted.

Returns:

boolean indicating document should be deleted from index

getLastModified

public Date getLastModified()

The last modified date of the document. This is used for determining that the GSA's version is older and that the GSA should recrawl soon (instead of natually discovering the modification). If null, then natural crawling is the primary method of detecting modifications.

Returns:

Date document was last modified

getResultLink

public URI getResultLink()

The URI that should be displayed to the user in search results. If null, then the crawl URI representing the DocId is used.

Returns:

URI link used in search results

isToBeCrawledImmediately

public boolean isToBeCrawledImmediately()

Informs the GSA that the document has been modified, and the GSA should give high priority to recrawling the document.

Returns:

boolean indicating file get crawl priority

isToBeCrawledOnce

public boolean isToBeCrawledOnce()

Informs the GSA that it should only crawl the document once. This disables automatic detection of modifications by the GSA for this document.

Returns:

boolean indicating file has should be crawled at most once

isToBeLocked

public boolean isToBeLocked()

Locks the document into the GSA's index. This informs the GSA that it should choose to evict other documents from its index when the document license limit is reached.

Returns:

boolean indicating file has priority to stay in index

getMetadata

public Metadata getMetadata()

The Metadata (possibly null) for the document this record is providing information for. See restrictions where metadata is declared.

Returns:

possibly null metadata for the document

equals

public boolean equals(Object o)

Checks for equality based on all visible fields.

Overrides:

equals in class Object

hashCode

public int hashCode()

Generates hash code based on all visible fields.

Overrides:

hashCode in class Object

toString

public String toString()

Generates a string representation of this instance useful for debugging that contains all visible fields.

Overrides:

toString in class Object