public class TdbCategory extends TdbMessageProvider implements com.tietoenator.trip.jxp.internal.utils.DOMSink, TdbControlObjectProvider, java.lang.Iterable<TdbTrainingInfo>
Constructor and Description |
---|
TdbCategory(TdbSession session)
Constructor, creates a blank instance
|
TdbCategory(TdbSession session,
TdbControlObject ob)
Constructor, creates an instance for the category referenced by the provided Control object
|
Modifier and Type | Method and Description |
---|---|
void |
get()
Retrieve information about the category.
|
java.lang.String |
getComment()
Retrieve any comment associated with the category
|
TdbControlObject |
getControlObject()
Retrieve the Control object reference with which the category was constructed
|
int |
getId()
Retrieve the unique ID assigned by the server to this category
|
java.lang.String |
getName()
Retrieve the name of the category
|
TdbClassificationScheme |
getScheme()
Retrieve a reference to the classification scheme with which this category
is associated
|
java.util.Iterator<TdbTrainingInfo> |
iterator()
Retrieve an iterator over the collection of training information available for this category
|
void |
rename()
Rename the category and/or provide it with a new comment.
|
void |
setComment(java.lang.String comment)
Establish a comment to be associated with the category
|
void |
setName(java.lang.String name)
Establish the name of the category
|
void |
train(java.lang.String data,
java.lang.String filename,
TdbTrainingInfo info)
Add training data to the category.
|
java.util.Collection<TdbTrainingInfo> |
trainingInfo()
Retrieve a copy of the collection of training information available for this category
|
void |
untrain()
Remove all training data for this category.
|
codeList, getLastCode, getLastMessage, hasMessages, messageList, resetMessages
cancel, getSession, isCancelable, setCancelable
public TdbCategory(TdbSession session, TdbControlObject ob) throws TdbException
session
- Active sessionob
- Control object referencing the categoryTdbException
public TdbCategory(TdbSession session) throws TdbException
session
- Active sessionTdbException
public TdbClassificationScheme getScheme()
public java.lang.String getName()
public void setName(java.lang.String name)
name
- The name of the new categorypublic java.lang.String getComment()
public void setComment(java.lang.String comment)
comment
- Category commentpublic int getId() throws TdbException
TdbException
public TdbControlObject getControlObject()
getControlObject
in interface TdbControlObjectProvider
public java.util.Iterator<TdbTrainingInfo> iterator()
iterator
in interface java.lang.Iterable<TdbTrainingInfo>
public java.util.Collection<TdbTrainingInfo> trainingInfo()
public void rename() throws TdbException
TdbException
public void train(java.lang.String data, java.lang.String filename, TdbTrainingInfo info) throws TdbException
data
- Training datafilename
- (optional) Filename from which training data was readinfo
- If not null, on completion will contain the new training information summaryTdbException
public void untrain() throws TdbException
TdbException
public void get() throws TdbException
TdbException