com.indexdata.mkjsf.pazpar2.data

Class ResponseDataObject

java.lang.Object

com.indexdata.mkjsf.pazpar2.data.ResponseDataObject

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ByTargetResponse, CommandError, Hit, InitResponse, Location, RecordResponse, SearchResponse, ServiceError, ShowResponse, SpResponseDataObject, StatResponse, Target, TargetCategory, TermListResponse, TermListsResponse, TermResponse

public class ResponseDataObject
extends java.lang.Object
implements java.io.Serializable

Parent class of all response data objects, with generic methods for retrieving data elements

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResponseDataObject()

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(java.lang.String name, ResponseDataObject value) Used by the response XML parser to add child element objects to a parent element object
void	appendContent(java.lang.String content)
CommandError	getApplicationError()
java.lang.String	getAttribute(java.lang.String name)
byte[]	getBinary()
java.util.List<ResponseDataObject>	getElements(java.lang.String name)
boolean	getHasResults()
int	getIntValue(java.lang.String name)
boolean	getIsBinary()
ResponseDataObject	getOneElement(java.lang.String name)
java.lang.String	getOneValue(java.lang.String name) Returns the text content of the first element found with the given name
java.lang.String	getProperty(java.lang.String name)
ServiceError	getServiceError()
java.lang.String	getType()
java.lang.String	getValue()
java.lang.String[]	getValueArray(java.lang.String name) Returns string array with the values of the named element(s)
java.lang.String	getXml()
boolean	hasApplicationError()
boolean	hasServiceError()
void	setAttribute(java.lang.String name, java.lang.String value)
void	setBinary(byte[] bytes)
void	setType(java.lang.String type)
void	setXml(java.lang.String xml)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseDataObject

public ResponseDataObject()

Method Detail

setType

public void setType(java.lang.String type)

getType

public java.lang.String getType()

setAttribute

public void setAttribute(java.lang.String name,
                java.lang.String value)

getAttribute

public java.lang.String getAttribute(java.lang.String name)

addElement

public void addElement(java.lang.String name,
              ResponseDataObject value)

Used by the response XML parser to add child element objects to a parent element object

Parameters:

name - of the child element

value - the child object itself

getElements

public java.util.List<ResponseDataObject> getElements(java.lang.String name)

getOneElement

public ResponseDataObject getOneElement(java.lang.String name)

getOneValue

public java.lang.String getOneValue(java.lang.String name)

Returns the text content of the first element found with the given name

Parameters:

name - of the element

Returns:

text value, empty string if none found

getValueArray

public java.lang.String[] getValueArray(java.lang.String name)

Returns string array with the values of the named element(s)

Parameters:

name - of the child object(s) to retrieve value(s) from

Returns:

appendContent

public void appendContent(java.lang.String content)

getValue

public java.lang.String getValue()

getProperty

public java.lang.String getProperty(java.lang.String name)

getIntValue

public int getIntValue(java.lang.String name)

hasApplicationError

public boolean hasApplicationError()

getApplicationError

public CommandError getApplicationError()

hasServiceError

public boolean hasServiceError()

getServiceError

public ServiceError getServiceError()

setXml

public void setXml(java.lang.String xml)

getXml

public java.lang.String getXml()

getHasResults

public boolean getHasResults()

getIsBinary

public boolean getIsBinary()

setBinary

public void setBinary(byte[] bytes)

getBinary

public byte[] getBinary()