nbi.xmlsec.biocase.protocol
Class SearchOperationType

java.lang.Object
  extended bynbi.xmlsec.biocase.protocol.ProtocolType
      extended bynbi.xmlsec.biocase.protocol.OperationType
          extended bynbi.xmlsec.biocase.protocol.SearchOperationType

public class SearchOperationType
extends OperationType

This class wraps the BioCASE protocol treeElements search operation type.

Since:
Version:
$Revision: 1.8 $
Author:
Lutz Suhrbier

Field Summary
(package private)  Boolean count
          The count
private static Boolean DEFAULT_COUNT
          Default value of the count
private static Integer DEFAULT_RESPONSEFORMAT_LIMIT
          Default value for the limit attribute of the response format
private static Integer DEFAULT_RESPONSEFORMAT_START
          Default value for the start attribute of the response format
(package private)  Operator filter
          The filter operator of this search operation
(package private) static Logger logger
           
(package private)  String responseFormat
          The response format
(package private)  Integer responseFormatLimit
          The attribute limit of the response format
(package private)  Integer responseFormatStart
          The attribute start of the response format
(package private)  String responseFormatTransformation
          The attribute transformation of the response format
 
Fields inherited from class nbi.xmlsec.biocase.protocol.OperationType
requestFormat
 
Fields inherited from class nbi.xmlsec.biocase.protocol.ProtocolType
protocolURI
 
Constructor Summary
SearchOperationType(String protocolURI)
          Inits this instance.
 
Method Summary
 Boolean getCount()
          Gets the count
 Operator getFilter()
          Gets the filter
 String getResponseFormat()
          Gets the responseFormat
 Integer getResponseFormatLimit()
          Gets the limit attribute of the response format.
 Integer getResponseFormatStart()
          Gets the start attribute of the response format.
 String getResponseFormatTransformation()
          Gets the responseFormatTransformation
 boolean isCount()
          If the value is null, the defined default value ( DEFAULT_COUNT) is returned.
 void setCount(Boolean count)
          Sets count.
 void setCount(String count)
          Sets count.
 void setFilter(Operator filter)
          Sets filter
 void setResponseFormat(String responseFormat)
          Sets responseFormat
 void setResponseFormatLimit(Integer responseFormatLimit)
          Sets the limit attribute of the response format.
 void setResponseFormatStart(Integer responseFormatStart)
          Sets the start attribute of the response format.
 void setResponseFormatTransformation(String responseFormatTransformation)
          Sets responseFormatTransformation
 String toString()
           
 void write(ContentHandler out)
          Writes the Operation type to a SAX Stream.
 
Methods inherited from class nbi.xmlsec.biocase.protocol.OperationType
getRequestFormat, setRequestFormat
 
Methods inherited from class nbi.xmlsec.biocase.protocol.ProtocolType
getProtocolURI
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

logger

static Logger logger

DEFAULT_RESPONSEFORMAT_START

private static final Integer DEFAULT_RESPONSEFORMAT_START
Default value for the start attribute of the response format


DEFAULT_RESPONSEFORMAT_LIMIT

private static final Integer DEFAULT_RESPONSEFORMAT_LIMIT
Default value for the limit attribute of the response format


DEFAULT_COUNT

private static final Boolean DEFAULT_COUNT
Default value of the count


responseFormat

String responseFormat
The response format


responseFormatStart

Integer responseFormatStart
The attribute start of the response format


responseFormatLimit

Integer responseFormatLimit
The attribute limit of the response format


responseFormatTransformation

String responseFormatTransformation
The attribute transformation of the response format


filter

Operator filter
The filter operator of this search operation


count

Boolean count
The count

Constructor Detail

SearchOperationType

public SearchOperationType(String protocolURI)
Inits this instance.

Parameters:
protocolURI - The protocol version of this instance.
Method Detail

write

public void write(ContentHandler out)
           throws SAXException
Writes the Operation type to a SAX Stream.

Specified by:
write in class OperationType
Parameters:
out - ContentHandlerto write to.
Throws:
SAXException

toString

public String toString()
Overrides:
toString in class OperationType

isCount

public boolean isCount()
If the value is null, the defined default value ( DEFAULT_COUNT) is returned.

Returns:
The value of count

getResponseFormatLimit

public Integer getResponseFormatLimit()
Gets the limit attribute of the response format. If the value is null, the defined default value ( DEFAULT_RESPONSEFORMAT_LIMIT) is returned.

Returns:
The value of count

getResponseFormatStart

public Integer getResponseFormatStart()
Gets the start attribute of the response format. If the value is null, the defined default value ( DEFAULT_RESPONSEFORMAT_START) is returned.

Returns:
The value of count

setCount

public void setCount(Boolean count)
Sets count. If the given parameter is null, the defined default value (false) is set.

Parameters:
count - The count to set.

setCount

public void setCount(String count)
Sets count. If the given parameter is null, the defined default value ( DEFAULT_RESPONSEFORMAT_LIMIT) is set.

Parameters:
count - The count to set.

setResponseFormatLimit

public void setResponseFormatLimit(Integer responseFormatLimit)
Sets the limit attribute of the response format. If the given parameter is null or non-negative, the defined default value ( DEFAULT_RESPONSEFORMAT_LIMIT) is set.

Parameters:
responseFormatLimit - The responseFormatLimit to set.

setResponseFormatStart

public void setResponseFormatStart(Integer responseFormatStart)
Sets the start attribute of the response format. If the given parameter is null or non-negative, the defined default value ( DEFAULT_RESPONSEFORMAT_START) is set.

Parameters:
responseFormatStart - The responseFormatStart to set.

getFilter

public Operator getFilter()
Gets the filter

Returns:
Returns the filter.

setFilter

public void setFilter(Operator filter)
Sets filter

Parameters:
filter - The filter to set.

getResponseFormat

public String getResponseFormat()
Gets the responseFormat

Returns:
Returns the responseFormat.

setResponseFormat

public void setResponseFormat(String responseFormat)
Sets responseFormat

Parameters:
responseFormat - The responseFormat to set.

getResponseFormatTransformation

public String getResponseFormatTransformation()
Gets the responseFormatTransformation

Returns:
Returns the responseFormatTransformation.

setResponseFormatTransformation

public void setResponseFormatTransformation(String responseFormatTransformation)
Sets responseFormatTransformation

Parameters:
responseFormatTransformation - The responseFormatTransformation to set.

getCount

public Boolean getCount()
Gets the count

Returns:
Returns the count.


Copyright © 2006 Lutz Suhrbier, Freie Universitšt Berlin. All Rights Reserved.