com.arsdigita.search
Class BaseDocument

java.lang.Object
  com.arsdigita.search.BaseDocument

All Implemented Interfaces:

Document

public class BaseDocument

extends Object

implements Document

A BaseDocument provides a base implementation of the Document interface. Query engine implementations shoudl use this class, or subclass it, rather than implementing the Document interface directly, since this makes them immune to future additions to the Document interface.

See Also:

Document

Constructor Summary

BaseDocument(OID oid, Locale locale, String title, String summary, Date creationDate, Party creationParty, Date modifiedDate, Party modifiedParty, BigDecimal score)
Creates a new document;

BaseDocument(URL url, OID oid, Locale locale, String title, String summary, Date creationDate, Party creationParty, Date modifiedDate, Party modifiedParty, BigDecimal score)

Method Summary

Date	getCreationDate() Gets the (optional) creation date of the DomainObject
Party	getCreationParty() Gets the (optional) creating party of the DomainObject
Date	getLastModifiedDate() Gets the (optional) last modification date of the DomainObject
Party	getLastModifiedParty() Gets the (optional) last modifying party of the DomainObject
Locale	getLocale() Gets the locale to which this object belongs
OID	getOID() Gets the unique OID for the domain object referenced by this document
BigDecimal	getScore() Gets the document score
String	getSummary() Gets the (optional) summary of the DomainObject
String	getTitle() Gets the Title property for the DomainObject
URL	getURL() Gets the URL for this document

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseDocument

public BaseDocument(OID oid,
                    Locale locale,
                    String title,
                    String summary,
                    Date creationDate,
                    Party creationParty,
                    Date modifiedDate,
                    Party modifiedParty,
                    BigDecimal score)

Creates a new document;

Parameters:

oid - the domain object's unique oid

locale - the locale of the document

title - the title of the document

summary - the optional summary

creationDate - the date on which the document was created

creationParty - the party who created the document

score - the score

BaseDocument

public BaseDocument(URL url,
                    OID oid,
                    Locale locale,
                    String title,
                    String summary,
                    Date creationDate,
                    Party creationParty,
                    Date modifiedDate,
                    Party modifiedParty,
                    BigDecimal score)

Method Detail

getOID

public OID getOID()

Gets the unique OID for the domain object referenced by this document

Specified by:

getOID in interface Document

Returns:

the unique OID

getURL

public URL getURL()

Gets the URL for this document

Specified by:

getURL in interface Document

Returns:

the document url

getLocale

public Locale getLocale()

Gets the locale to which this object belongs

Specified by:

getLocale in interface Document

Returns:

the locale of the object

getTitle

public String getTitle()

Gets the Title property for the DomainObject

Specified by:

getTitle in interface Document

Returns:

title of the object

getSummary

public String getSummary()

Gets the (optional) summary of the DomainObject

Specified by:

getSummary in interface Document

Returns:

the object summary, or null

getCreationDate

public Date getCreationDate()

Gets the (optional) creation date of the DomainObject

Specified by:

getCreationDate in interface Document

Returns:

the creation date, or null

getCreationParty

public Party getCreationParty()

Gets the (optional) creating party of the DomainObject

Specified by:

getCreationParty in interface Document

Returns:

the creation party, or null

getLastModifiedDate

public Date getLastModifiedDate()

Gets the (optional) last modification date of the DomainObject

Specified by:

getLastModifiedDate in interface Document

Returns:

the modification date, or null

getLastModifiedParty

public Party getLastModifiedParty()

Gets the (optional) last modifying party of the DomainObject

Specified by:

getLastModifiedParty in interface Document

Returns:

the modification party, or null

getScore

public BigDecimal getScore()

Gets the document score

Specified by:

getScore in interface Document

Returns:

the score