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.

• 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.

• 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.

• isToBeCrawledImmediately

  public boolean isToBeCrawledImmediately()

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

• 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.

• 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.

• 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