Overview  Package   Class  Use  Deprecated  Index
Home >> All >> recoinx >> [ clef overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

recoinx.clef
Class CLEFResultList  

java.lang.Object
  recoin.group.ComponentSupportImpl
      recoin.container.ResultList
          recoinx.clef.CLEFResultList

All Implemented Interfaces:

recoin.group.ComponentSupport, java.io.Serializable

---

public class CLEFResultList

extends recoin.container.ResultList

A CLEFResultList extends a simple ResultList. It provides special attributes and methods to store and access data about the topic that was used to create this CLEFResultList and the collection that was queried.

Version:

0.2.9

---

Field Summary
private  int	collection           The collection of this CLEFResultList.
(package private) static org.apache.log4j.Logger	logger           The logger for this class.
private  CLEFQuery.CLEFTopic	topic           The topic.

 

Fields inherited from class recoin.container.ResultList

resultClass, results

 

Fields inherited from class recoin.group.ComponentSupportImpl

chainID, classname, description, id, name

 

Constructor Summary

CLEFResultList()           Creates a new CLEFResultList.

CLEFResultList(CLEFResultList list)           Creates a new CLEFResultList that copies the attributes and results of the specified CLEFResultList.

 

Method Summary
int	getCollection()           Returns the collection.
java.lang.String	getCollectionCode()           Returns a short name of the collection of the CLEFResultList.
int	getLanguage()           Returns the language.
CLEFQuery.CLEFTopic	getTopic()           Returns this CLEFResultList's CLEFTopic.
java.lang.String	getTopicNumber()           Returns the topic number that is stored in this CLEFResultList's CLEFTopic.
void	setCollection(int i)           Sets the collection of this CLEFResultList to the specified one.
void	setTopic(CLEFQuery.CLEFTopic top)           Sets the CLEFTopic of this CLEFResultList.
java.lang.String	toXML()           Returns a XML representation of this CLEFResultList.

 

Methods inherited from class recoin.container.ResultList

addResult, getResultCount, getResults, setResultClass, setResults

 

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

logger

static org.apache.log4j.Logger logger

The logger for this class.

---

collection

private int collection

The collection of this CLEFResultList. Default is -1 for 'No Collection'.

---

topic

private CLEFQuery.CLEFTopic topic

The topic.

Constructor Detail

CLEFResultList

public CLEFResultList()

Creates a new CLEFResultList.

---

CLEFResultList

public CLEFResultList(CLEFResultList list)

Creates a new CLEFResultList that copies the attributes and results of the specified CLEFResultList.

Method Detail

getLanguage

public int getLanguage()

Returns the language.

---

getCollection

public int getCollection()

Returns the collection.

---

getCollectionCode

public java.lang.String getCollectionCode()

Returns a short name of the collection of the CLEFResultList. Actually this is the same as calling CLEFConstants.getCollectionTable(int) with this CLEFResultList's collection fiels as parameter.

---

setCollection

public void setCollection(int i)

Sets the collection of this CLEFResultList to the specified one.

---

toXML

public java.lang.String toXML()

Returns a XML representation of this CLEFResultList. The returned String will be a valid XML file including a prolog.

---

getTopicNumber

public java.lang.String getTopicNumber()

Returns the topic number that is stored in this CLEFResultList's CLEFTopic.

---

setTopic

public void setTopic(CLEFQuery.CLEFTopic top)

Sets the CLEFTopic of this CLEFResultList.

---

getTopic

public CLEFQuery.CLEFTopic getTopic()

Returns this CLEFResultList's CLEFTopic.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> recoinx >> [ clef overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---