moj.lang.statserv
Class WordTagRequest

java.lang.Object
  extended by moj.lang.statserv.StatServRequest
      extended by moj.lang.statserv.WordTagRequest

public class WordTagRequest
extends StatServRequest

A StatServRequest module that requests and supplies frequencies on PoS tagged words.

Version:
2006-Dec-13
Author:
Martin Hassel

Field Summary
 int localTokens
           
 int referenceDocuments
           
 int referenceTokens
           
 
Fields inherited from class moj.lang.statserv.StatServRequest
addstats, classname, docset, localstats, referencestats
 
Constructor Summary
WordTagRequest(java.lang.String docset, boolean localstats, boolean referencestats, boolean addstats)
          Creates new WordTagRequest and fills mandatory fields.
 
Method Summary
 java.util.Map<java.lang.String,java.lang.Integer> getLocalTF()
           
 int getLocalTokens()
           
 java.util.Map<java.lang.String,java.lang.Integer> getReferenceDF()
           
 int getReferenceDocuments()
           
 java.util.Map<java.lang.String,java.lang.Integer> getReferenceTF()
           
 int getReferenceTokens()
           
 boolean parse(java.io.Reader xmlReader)
          Parses the XML passed via the Reader and fills the modules data structures.
 java.lang.String requestXML()
          Returns the XML that constitutes the modules part in a StatServConnection request.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

localTokens

public int localTokens

referenceTokens

public int referenceTokens

referenceDocuments

public int referenceDocuments
Constructor Detail

WordTagRequest

public WordTagRequest(java.lang.String docset,
                      boolean localstats,
                      boolean referencestats,
                      boolean addstats)
Creates new WordTagRequest and fills mandatory fields.

Parameters:
docset - the document set statistics is requested for
localstats - is local statistics requested?
referencestats - is reference statistics requested?
addstats - is statistics to be added to the document set?
Method Detail

requestXML

public java.lang.String requestXML()
Returns the XML that constitutes the modules part in a StatServConnection request.

Specified by:
requestXML in class StatServRequest
Returns:
XML representing the modules part in a request

parse

public boolean parse(java.io.Reader xmlReader)
Parses the XML passed via the Reader and fills the modules data structures.

Specified by:
parse in class StatServRequest
Parameters:
xmlReader - Reader wrapping the XML response from a StatServConnection request.
Returns:
true on success, else false

getLocalTF

public java.util.Map<java.lang.String,java.lang.Integer> getLocalTF()
Returns:
Returns the localTF.

getLocalTokens

public int getLocalTokens()
Returns:
Returns the number of tokens in the reference data set.

getReferenceDocuments

public int getReferenceDocuments()
Returns:
Returns the number of documents in the reference data set.

getReferenceTokens

public int getReferenceTokens()
Returns:
Returns the number of tokens in the reference data set.

getReferenceDF

public java.util.Map<java.lang.String,java.lang.Integer> getReferenceDF()
Returns:
Returns the referenceDF.

getReferenceTF

public java.util.Map<java.lang.String,java.lang.Integer> getReferenceTF()
Returns:
Returns the referenceTF.