gov.sandia.cognition.text.term
Class DefaultTermNGram

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.text.term.AbstractTerm
          extended by gov.sandia.cognition.text.term.DefaultTermNGram
All Implemented Interfaces:
Term, Termable, TermNGram, CloneableSerializable, Named, Serializable, Cloneable

public class DefaultTermNGram
extends AbstractTerm
implements TermNGram

A default implementation of the TermNGram interface.

Since:
3.0
Author:
Justin Basilico
See Also:
Serialized Form

Field Summary
protected  Term[] terms
          The array of terms that make up the n-gram.
 
Constructor Summary
DefaultTermNGram()
          Creates a new DefaultTermNGram.
DefaultTermNGram(Term... terms)
          Creates a new DefaultTermNGram.
 
Method Summary
 DefaultTermNGram clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 String getName()
          The name of the n-gram term is [<n>-gram: <list>] where n is the size ot this n-gram and list is a comma-separated list of the internal term names.
 Term getTerm(int i)
          Gets the i-th term in the n-gram.
 int getTermCount()
          Gets the number of terms in the n-gram.
 List<Term> getTermList()
          Gets the list of terms in the n-gram.
 Term[] getTerms()
          Gets the terms that make up the n-gram.
 void setTerms(Term... terms)
          Sets the terms that make up the n-gram.
 
Methods inherited from class gov.sandia.cognition.text.term.AbstractTerm
asTerm, equals, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface gov.sandia.cognition.text.term.Termable
asTerm
 

Field Detail

terms

protected Term[] terms
The array of terms that make up the n-gram.

Constructor Detail

DefaultTermNGram

public DefaultTermNGram()
Creates a new DefaultTermNGram.


DefaultTermNGram

public DefaultTermNGram(Term... terms)
Creates a new DefaultTermNGram.

Parameters:
terms - The terms that make up the n-gram.
Method Detail

clone

public DefaultTermNGram clone()
Description copied from class: AbstractCloneableSerializable
This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

getName

public String getName()
The name of the n-gram term is [<n>-gram: <list>] where n is the size ot this n-gram and list is a comma-separated list of the internal term names.

Specified by:
getName in interface Named
Returns:
The name of the term.

getTermCount

public int getTermCount()
Description copied from interface: TermNGram
Gets the number of terms in the n-gram.

Specified by:
getTermCount in interface TermNGram
Returns:
The number of terms in the n-gram.

getTerm

public Term getTerm(int i)
Description copied from interface: TermNGram
Gets the i-th term in the n-gram.

Specified by:
getTerm in interface TermNGram
Parameters:
i - The zero-based index of the term to get.
Returns:
The i-th term in the n-gram.

getTermList

public List<Term> getTermList()
Description copied from interface: TermNGram
Gets the list of terms in the n-gram.

Specified by:
getTermList in interface TermNGram
Returns:
The list of terms in the n-gram.

getTerms

public Term[] getTerms()
Gets the terms that make up the n-gram.

Returns:
The terms that make up the n-gram.

setTerms

public void setTerms(Term... terms)
Sets the terms that make up the n-gram.

Parameters:
terms - The terms that make up the n-gram.