edu.northwestern.at.wordhoard.model.userdata
Class PhraseSetPhraseCount

java.lang.Object
  edu.northwestern.at.wordhoard.model.userdata.PhraseSetPhraseCount

All Implemented Interfaces:

PersistentObject, java.io.Serializable

public class PhraseSetPhraseCount
extends java.lang.Object
implements java.io.Serializable, PersistentObject

Count of a single phrase in a PhraseSet.

A phrase set phrase count entry contains the following:

• A unique integer id for the phrase count.
• The phrase text. May be a spelling, lemma, gender, etc.
• The word form for the phrase text (see WordForms).
• The PhraseSet to which this count pertains.
• The tag of the WorkPart to which this count pertains.
• The count of the phrase form in this phrase set in the specified work part.

See Also:

Serialized Form

Constructor Summary

PhraseSetPhraseCount()
Create an empty phrase count object.

PhraseSetPhraseCount(Spelling phraseText, int wordForm, PhraseSet phraseSet, java.lang.String workPartTag, int phraseCount)
Create a populated phrase count object.

Method Summary

java.lang.Long	getId() Get the persistence id.
int	getPhraseCount() Get the phrase count.
PhraseSet	getPhraseSet() Get the phrase set.
Spelling	getPhraseText() Get the phrase text.
int	getWordForm() Get the word form.
java.lang.String	getWorkPartTag() Get the tag of the work part to which this count pertains.
protected void	setPhraseText(Spelling phraseText) Set the phrase text.
java.lang.String	toString() Return string form of this entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

PhraseSetPhraseCount

public PhraseSetPhraseCount()

Create an empty phrase count object.

PhraseSetPhraseCount

public PhraseSetPhraseCount(Spelling phraseText,
                            int wordForm,
                            PhraseSet phraseSet,
                            java.lang.String workPartTag,
                            int phraseCount)

Create a populated phrase count object.

Method Detail

getId

public java.lang.Long getId()

Get the persistence id.

Specified by:

getId in interface PersistentObject

Returns:

The persistence id.

getPhraseText

public Spelling getPhraseText()

Get the phrase text.

Returns:

The phrase text.

setPhraseText

protected void setPhraseText(Spelling phraseText)

Set the phrase text.

Parameters:

phraseText - The phrase text.

getWordForm

public int getWordForm()

Get the word form.

Returns:

The word form type.

getPhraseSet

public PhraseSet getPhraseSet()

Get the phrase set.

Returns:

The phrase set.

getWorkPartTag

public java.lang.String getWorkPartTag()

Get the tag of the work part to which this count pertains.

Returns:

The work part tag.

getPhraseCount

public int getPhraseCount()

Get the phrase count.

Returns:

The phrase count.

toString

public java.lang.String toString()

Return string form of this entry.

Overrides:

toString in class java.lang.Object

Returns:

The word form text.