Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

recoinx.clef
Class CLEFQuery  view CLEFQuery download CLEFQuery.java

java.lang.Object
  extended byrecoin.group.ComponentSupportImpl
      extended byrecoin.container.Query
          extended byrecoinx.clef.CLEFQuery
All Implemented Interfaces:
recoin.group.ComponentSupport, java.io.Serializable

public class CLEFQuery
extends recoin.container.Query

The CLEFQuery is a subclass of Query offering special attributes and behavior used in CLEF.


Nested Class Summary
 class CLEFQuery.CLEFTopic
          The CLEFTopic class encapsulates data about a topic of a particular language.
 
Field Summary
private  java.lang.String topicNumber
          The topic number.
private  CLEFQuery.CLEFTopic[] topics
          The CLEFTopics.
 
Fields inherited from class recoin.container.Query
 
Fields inherited from class recoin.group.ComponentSupportImpl
chainID, classname, description, id, name
 
Constructor Summary
CLEFQuery()
          Creates a new CLEFQuery with an empty topic array that has the size of 4.
CLEFQuery(java.lang.String topicNo)
          Creates a new CLEFQuery with the specified topic number and with an empty topic array that has the size of 4.
 
Method Summary
 void addTopic(java.lang.String topic, int language)
          Adds a new topic to this CLEFQuery using the specified topic content and the specified language.
Note: Adding a topic will replace any previously added topic of the same language!
 CLEFQuery.CLEFTopic getTopic(int language)
          Returns the content of the topic that has the specified language.
 java.lang.String getTopicNumber()
          Returns the topic number of this CLEFQuery.
 
Methods inherited from class recoin.container.Query
getCutOff, setCutOff
 
Methods inherited from class recoin.group.ComponentSupportImpl
getChainID, getClassname, getDescription, getID, getName, setChainID, setClassname, setDescription, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

topics

private CLEFQuery.CLEFTopic[] topics
The CLEFTopics. One for each of the different languages. The index of the topic in the array is determined by its language index, see CLEFConstants.


topicNumber

private java.lang.String topicNumber
The topic number.

Constructor Detail

CLEFQuery

public CLEFQuery()
Creates a new CLEFQuery with an empty topic array that has the size of 4.


CLEFQuery

public CLEFQuery(java.lang.String topicNo)
Creates a new CLEFQuery with the specified topic number and with an empty topic array that has the size of 4.

Method Detail

addTopic

public void addTopic(java.lang.String topic,
                     int language)
Adds a new topic to this CLEFQuery using the specified topic content and the specified language.
Note: Adding a topic will replace any previously added topic of the same language!


getTopic

public CLEFQuery.CLEFTopic getTopic(int language)
Returns the content of the topic that has the specified language. The method will return NULL if no topic with the specified language can be found.


getTopicNumber

public java.lang.String getTopicNumber()
Returns the topic number of this CLEFQuery.