de.unirostock.sems.bives.webservice.client

Class BivesSingleFileResponse

java.lang.Object

de.unirostock.sems.bives.webservice.client.BivesResponse

de.unirostock.sems.bives.webservice.client.BivesSingleFileResponse

All Implemented Interfaces:

BivesCommands, BivesSingleFileCommands, Serializable

public class BivesSingleFileResponse
extends BivesResponse
implements BivesSingleFileCommands

The Class BivesSingleFileResponse representing a response of a single-file-request sent to the BiVeS web service.

Author:

martin

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	documentTypes The document types.
protected HashMap<String,String>	meta The meta informations.
protected HashMap<String,Integer>	nodeStats The node statistics.

Fields inherited from class de.unirostock.sems.bives.webservice.client.BivesResponse

bivesResults, error

Fields inherited from interface de.unirostock.sems.bives.webservice.client.BivesSingleFileCommands

COMMAND_DOCUMENT_TYPE, COMMAND_META, COMMAND_SINGLE_FILE_COMPONENT_HIERARCHY_DOT, COMMAND_SINGLE_FILE_COMPONENT_HIERARCHY_GRAPHML, COMMAND_SINGLE_FILE_COMPONENT_HIERARCHY_JSON, COMMAND_SINGLE_FILE_REACTIONS_DOT, COMMAND_SINGLE_FILE_REACTIONS_GRAPHML, COMMAND_SINGLE_FILE_REACTIONS_JSON, COMMAND_SINGLE_FLATTEN

Fields inherited from interface de.unirostock.sems.bives.webservice.client.BivesCommands

COMMAND_FORCE_CELLML, COMMAND_FORCE_REGULAR, COMMAND_FORCE_SBML, COMMAND_SET_LOG_STACKTRACE, COMMAND_SET_VERBOSE

Constructor Summary

Constructors

Constructor and Description
BivesSingleFileResponse() Instantiates a new bives single file response.

Method Summary

Modifier and Type	Method and Description
void	addDocumentType(String documentType) Adds another document type to the list of document types.
List<String>	getDocumentTypes() Gets the document types.
HashMap<String,String>	getMeta() Gets the meta informations.
HashMap<String,Integer>	getNodeStats() Gets the node statistics as a map: NODE_NAME => OCCURRENCES.
void	postProcess() Post process a response.
void	setDocumentTypes(List<String> documentTypes) Sets the document types.
void	setMeta(String key, String value) Sets the meta informations.
void	setNodeStats(String tag, int occurences) Sets the statistics for a certain node type.

Methods inherited from class de.unirostock.sems.bives.webservice.client.BivesResponse

addError, getErrors, getResult, hasError, setResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

meta

protected HashMap<String,String> meta

The meta informations.

nodeStats

protected HashMap<String,Integer> nodeStats

The node statistics.

documentTypes

protected List<String> documentTypes

The document types.

Constructor Detail

BivesSingleFileResponse

public BivesSingleFileResponse()

Instantiates a new bives single file response.

Method Detail

getMeta

public HashMap<String,String> getMeta()

Gets the meta informations.

Returns:

the meta

setMeta

public void setMeta(String key,
                    String value)

Sets the meta informations.

Parameters:

key - the identify for the meta information

value - the meta information to set

setNodeStats

public void setNodeStats(String tag,
                         int occurences)

Sets the statistics for a certain node type. Statistics being the number of occurences of this node in the document.

Parameters:

tag - the tag name of the node

occurences - the number of nodes in the document that share this tag name

getNodeStats

public HashMap<String,Integer> getNodeStats()

Gets the node statistics as a map: NODE_NAME => OCCURRENCES.

Returns:

the node statistics

addDocumentType

public void addDocumentType(String documentType)

Adds another document type to the list of document types.

Parameters:

documentType - the new document type that applies to the document

setDocumentTypes

public void setDocumentTypes(List<String> documentTypes)

Sets the document types. This will overwrite the existing list of document types.

Parameters:

documentTypes - the list of document types that apply to the document

getDocumentTypes

public List<String> getDocumentTypes()

Gets the document types.

Returns:

the document types

postProcess

public void postProcess()

Description copied from class: BivesResponse

Post process a response.

Specified by:

postProcess in class BivesResponse