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

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

All Implemented Interfaces:

PersistentObject, java.io.Serializable

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

Count of a single word in a WordSet.

A word set word count entry contains the following:

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

See Also:

Serialized Form

Constructor Summary

WordSetWordCount()
Create an empty word form count object.

WordSetWordCount(Spelling word, int wordForm, WordSet wordSet, java.lang.String workPartTag, int wordCount)
Create a populated word form count object.

Method Summary

java.lang.Long	getId() Get the persistence id.
Spelling	getWord() Get the word text.
int	getWordCount() Get the word count in the word set.
int	getWordForm() Get the word form.
WordSet	getWordSet() Get the word set.
java.lang.String	getWorkPartTag() Get the tag of the work part to which this count pertains.
protected void	setWord(Spelling word) Set the word 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

WordSetWordCount

public WordSetWordCount()

Create an empty word form count object.

WordSetWordCount

public WordSetWordCount(Spelling word,
                        int wordForm,
                        WordSet wordSet,
                        java.lang.String workPartTag,
                        int wordCount)

Create a populated word form count object.

Method Detail

getId

public java.lang.Long getId()

Get the persistence id.

Specified by:

getId in interface PersistentObject

Returns:

The persistence id.

getWord

public Spelling getWord()

Get the word text.

Returns:

The word text.

setWord

protected void setWord(Spelling word)

Set the word text.

Parameters:

word - The word text.

getWordForm

public int getWordForm()

Get the word form.

Returns:

The word form type.

getWordSet

public WordSet getWordSet()

Get the word set.

Returns:

The word set.

getWorkPartTag

public java.lang.String getWorkPartTag()

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

Returns:

The work part tag.

getWordCount

public int getWordCount()

Get the word count in the word set.

Returns:

The word count in the word set.

toString

public java.lang.String toString()

Return string form of this entry.

Overrides:

toString in class java.lang.Object

Returns:

The word form text.