prajna.data

Class DocData

java.lang.Object

prajna.data.DocData

Direct Known Subclasses:

AlchemyDocData, HtmlDocData, TemplatedHtmlDocData

public class DocData
extends java.lang.Object

This class represents document meta-data for a particular document. It includes the ability to associate various keys with a document. These can be used as keywords or indices. The body of the document and a summary are also available, though implementations are not required to load bodies or summaries.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
DocData(java.lang.String title) Instantiates a new DocumentData object
DocData(java.lang.String title, java.util.Set<java.lang.String> docKeys) Instantiates a new DocData object with the given set of keys

Method Summary

Methods

Modifier and Type	Method and Description
void	addKey(java.lang.String key) Adds a key to the Document metadata
void	addKey(java.lang.String key, java.lang.Object value) Adds a key to the Document metadata with an associated value
void	addKeyMap(java.util.Map<java.lang.String,? extends java.lang.Object> keyMap) Add a group of keys with values to this docData object.
int	calculateSimilarity(DocData doc) Calculate similarity between this DocData and another DocData object based upon the keys that have been set.
void	clearKeys() Clears the keys associated with this DocData object
boolean	equals(java.lang.Object obj) Return whether this DocData object is equal to another object.
java.lang.String	getBody() Gets the body.
java.util.Map<java.lang.String,java.lang.Object>	getKeyMap() Return the set of keys with their mapped values
java.util.Set<java.lang.String>	getKeys() Gets the set of keys for this document object.
java.lang.String	getLink() Get the link associated with this record.
java.lang.String	getName() Get the name or title of this document
java.util.List<java.lang.String>	getSections() Return the sections of the document in order.
java.lang.String	getSummary() Gets the summary data.
java.util.Date	getTimeStamp() Get the timestamp for the document.
java.lang.Object	getValueForKey(java.lang.String key) Gets the value associated with a key
int	hashCode() Return the hashcode for this DocData object
boolean	loadContent() Loads the content, keys, and other fields for this document.
boolean	matchesKey(java.lang.String key) Determines if this DocData matches the specified key.
void	setBody(java.lang.String docBody) Set the document body
void	setLink(java.lang.String linkString) Set the link associated with this record.
void	setName(java.lang.String newName) Set the name or title of this DocData object.
void	setSummary(java.lang.String docSummary) Sets the summary.
void	setTimeStamp(java.util.Date date) Set the timestamp for the document.
java.lang.String	toString() Get the string representation of this DocData object

Methods inherited from class java.lang.Object

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

Constructor Detail

DocData

public DocData(java.lang.String title)

Instantiates a new DocumentData object

Parameters:

title - the title of the document

DocData

public DocData(java.lang.String title,
       java.util.Set<java.lang.String> docKeys)

Instantiates a new DocData object with the given set of keys

Parameters:

title - the document title

docKeys - the set of keys for the document

Method Detail

addKey

public void addKey(java.lang.String key)

Adds a key to the Document metadata

Parameters:

key - the key

addKey

public void addKey(java.lang.String key,
          java.lang.Object value)

Adds a key to the Document metadata with an associated value

Parameters:

key - the key

value - a value object

addKeyMap

public void addKeyMap(java.util.Map<java.lang.String,? extends java.lang.Object> keyMap)

Add a group of keys with values to this docData object.

Parameters:

keyMap - the map of keys for this docData object

calculateSimilarity

public int calculateSimilarity(DocData doc)

Calculate similarity between this DocData and another DocData object based upon the keys that have been set. The similarity score returned is equal to the number of keys the two objects have in common.

Parameters:

doc - the doc record to compare to

Returns:

A similarity score

clearKeys

public void clearKeys()

Clears the keys associated with this DocData object

equals

public boolean equals(java.lang.Object obj)

Return whether this DocData object is equal to another object. If the other object is a DocData object, and it has the same name, link, body, and keys, then the two Docdata objects are considered equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare to

Returns:

true if this object equals the other object, false otherwise.

getBody

public java.lang.String getBody()

Gets the body. This is the content of the document. If the body has not been set, this will return the empty string.

Returns:

the body

getKeyMap

public java.util.Map<java.lang.String,java.lang.Object> getKeyMap()

Return the set of keys with their mapped values

Returns:

the key mapping

getKeys

public java.util.Set<java.lang.String> getKeys()

Gets the set of keys for this document object.

Returns:

the keys

getLink

public java.lang.String getLink()

Get the link associated with this record.

Returns:

the link for this record

getName

public java.lang.String getName()

Get the name or title of this document

Returns:

the name or title

getSections

public java.util.List<java.lang.String> getSections()

Return the sections of the document in order. For this simple implementation, this method returns a list containing the body as the single element

Returns:

a list of document sections

getSummary

public java.lang.String getSummary()

Gets the summary data. If the summary has not been set, this will return the empty string.

Returns:

the summary

getTimeStamp

public java.util.Date getTimeStamp()

Get the timestamp for the document. The timestamp should be the document publish date, if defined. The timestamp is null by default

Returns:

the timestamp for the document

getValueForKey

public java.lang.Object getValueForKey(java.lang.String key)

Gets the value associated with a key

Parameters:

key - the key to query

Returns:

the value associated with the key

hashCode

public int hashCode()

Return the hashcode for this DocData object

Overrides:

hashCode in class java.lang.Object

Returns:

the hashcode for this object

loadContent

public boolean loadContent()

Loads the content, keys, and other fields for this document. This method ensures that all content that can be obtained from the document is available. This method returns true if the data has been loaded without error, or false if there is a problem loading the data. The default implementation does nothing and returns true, but subclasses can override this behavior to

Returns:

true if the content can be loaded without error, false otherwise.

matchesKey

public boolean matchesKey(java.lang.String key)

Determines if this DocData matches the specified key.

Parameters:

key - the key

Returns:

true, if the key has been added to this DocData object

setBody

public void setBody(java.lang.String docBody)

Set the document body

Parameters:

docBody - the document body

setLink

public void setLink(java.lang.String linkString)

Set the link associated with this record. The link can be anything from a URL hyper-link to an action string, based upon the need of the program manipulating the data records.

Parameters:

linkString - the link associated with the record

setName

public void setName(java.lang.String newName)

Set the name or title of this DocData object.

Parameters:

newName - the new Document name or title

setSummary

public void setSummary(java.lang.String docSummary)

Sets the summary.

Parameters:

docSummary - the new summary

setTimeStamp

public void setTimeStamp(java.util.Date date)

Set the timestamp for the document. The timestamp should be the document publish date, if defined. The timestamp is null by default

Parameters:

date - the timestamp for the document

toString

public java.lang.String toString()

Get the string representation of this DocData object

Overrides:

toString in class java.lang.Object

Returns:

String representation of this DocData object