Class TdbCategory

All Implemented Interfaces:
com.tietoenator.trip.jxp.internal.utils.DOMSink, TdbControlObjectProvider, Iterable<TdbTrainingInfo>

public class TdbCategory extends TdbMessageProvider implements com.tietoenator.trip.jxp.internal.utils.DOMSink, TdbControlObjectProvider, Iterable<TdbTrainingInfo>
Container and manipulation logic for a single category from a classification scheme
  • Constructor Details

    • TdbCategory

      public TdbCategory(TdbSession session, TdbControlObject ob) throws TdbException
      Constructor, creates an instance for the category referenced by the provided Control object
      Parameters:
      session - Active session
      ob - Control object referencing the category
      Throws:
      TdbException
    • TdbCategory

      public TdbCategory(TdbSession session) throws TdbException
      Constructor, creates a blank instance
      Parameters:
      session - Active session
      Throws:
      TdbException
  • Method Details

    • getScheme

      public TdbClassificationScheme getScheme()
      Retrieve a reference to the classification scheme with which this category is associated
      Returns:
      Reference to the containing classification scheme
    • getName

      public String getName()
      Retrieve the name of the category
      Returns:
      Category name
    • setName

      public void setName(String name)
      Establish the name of the category
      Parameters:
      name - The name of the new category
    • getComment

      public String getComment()
      Retrieve any comment associated with the category
      Returns:
      Category comment, if any
    • setComment

      public void setComment(String comment)
      Establish a comment to be associated with the category
      Parameters:
      comment - Category comment
    • getId

      public int getId() throws TdbException
      Retrieve the unique ID assigned by the server to this category
      Returns:
      Category ID
      Throws:
      TdbException
    • getControlObject

      public TdbControlObject getControlObject()
      Retrieve the Control object reference with which the category was constructed
      Specified by:
      getControlObject in interface TdbControlObjectProvider
      Returns:
      Control object reference
    • iterator

      public Iterator<TdbTrainingInfo> iterator()
      Retrieve an iterator over the collection of training information available for this category
      Specified by:
      iterator in interface Iterable<TdbTrainingInfo>
      Returns:
      Training information iterator
    • trainingInfo

      public Collection<TdbTrainingInfo> trainingInfo()
      Retrieve a copy of the collection of training information available for this category
      Returns:
      Training information collection
    • rename

      public void rename() throws TdbException
      Rename the category and/or provide it with a new comment. Invoking this method causes network I/O.
      Throws:
      TdbException
    • train

      public void train(String data, String filename, TdbTrainingInfo info) throws TdbException
      Add training data to the category. Invoking this method causes network I/O.
      Parameters:
      data - Training data
      filename - (optional) Filename from which training data was read
      info - If not null, on completion will contain the new training information summary
      Throws:
      TdbException
    • untrain

      public void untrain() throws TdbException
      Remove all training data for this category. Invoking this method causes network I/O.
      Throws:
      TdbException
    • get

      public void get() throws TdbException
      Retrieve information about the category. Invoking this method causes network I/O.
      Throws:
      TdbException