|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectmoj.lang.statserv.modules.StatServRequest
public abstract class StatServRequest
StatServRequest in an abstract class that stipulates what fields and methods a StatServ request module at least should supply and implement.
| Field Summary | |
|---|---|
java.lang.String |
classname
|
| Method Summary | |
|---|---|
boolean |
addReferenceSet(java.lang.String docset)
Add a document set to request reference statistics from. |
boolean |
addReferenceSets(java.util.Set<java.lang.String> docsets)
Add a set of document sets to request reference statistics from. |
java.lang.String |
addStatsToSet(java.lang.String docset)
Specify a document set to add local statistics for the current request to. |
boolean |
checkSimilarity(boolean check_similarity)
Turns the similarity check, when adding local statistics for the current request to chosen document set, on or off. |
boolean |
getLocalStats(boolean localstats)
Turns retrieval of "local" statistics on or off. |
abstract boolean |
parse(java.io.Reader xmlReader)
Parses the XML passed via the Reader and fills the modules
data structures. |
abstract 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 |
|---|
public final java.lang.String classname
| Method Detail |
|---|
public boolean getLocalStats(boolean localstats)
localstats - true for on, false for off
public boolean addReferenceSet(java.lang.String docset)
docset - document set to add to request
true on successpublic boolean addReferenceSets(java.util.Set<java.lang.String> docsets)
docsets - document sets to add to request
true on successpublic boolean checkSimilarity(boolean check_similarity)
check_similarity - true for on, false for off
public java.lang.String addStatsToSet(java.lang.String docset)
docset - document set to add local statistics to
public abstract java.lang.String requestXML()
StatServConnection request.
public abstract boolean parse(java.io.Reader xmlReader)
Reader and fills the modules
data structures.
xmlReader - Reader wrapping the XML response from a
StatServConnection request.
true on success, else false
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||