cgl.hpsearch.common.xml
Class ServiceSpecification

java.lang.Object
  cgl.hpsearch.common.xml.ServiceSpecification

All Implemented Interfaces:

Serializable

public class ServiceSpecification

extends Object

implements Serializable

ServiceSpecification specifies the details required to initialize a service. This includes the following

• ServiceName - Name of service to invoke
• Service Parameters - name/value pair
• Input, output and error streams

Version:

$Revision: 1.1 $ $Date: 2005/10/16 14:40:45 $

Author:

Harshawardhan S. Gadgil

See Also:

Serialized Form

Constructor Summary

ServiceSpecification()

Method Summary

void	addInput(int index, String vInput) Method addInput
void	addInput(String vInput) Method addInput
void	addOutput(int index, String vOutput) Method addOutput
void	addOutput(String vOutput) Method addOutput
void	addParameter(int index, Parameter vParameter) Method addParameter
void	addParameter(Parameter vParameter) Method addParameter
Enumeration	enumerateInput() Method enumerateInput
Enumeration	enumerateOutput() Method enumerateOutput
Enumeration	enumerateParameter() Method enumerateParameter
String	getErrorStream() Returns the value of field 'errorStream'.
String[]	getInput() Method getInput
String	getInput(int index) Method getInput
int	getInputCount() Method getInputCount
String[]	getOutput() Method getOutput
String	getOutput(int index) Method getOutput
int	getOutputCount() Method getOutputCount
Parameter[]	getParameter() Method getParameter
Parameter	getParameter(int index) Method getParameter
int	getParameterCount() Method getParameterCount
String	getServiceID() Returns the value of field 'serviceID'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
void	removeAllInput() Method removeAllInput
void	removeAllOutput() Method removeAllOutput
void	removeAllParameter() Method removeAllParameter
String	removeInput(int index) Method removeInput
String	removeOutput(int index) Method removeOutput
Parameter	removeParameter(int index) Method removeParameter
void	setErrorStream(String errorStream) Sets the value of field 'errorStream'.
void	setInput(int index, String vInput) Method setInput
void	setInput(String[] inputArray) Method setInput
void	setOutput(int index, String vOutput) Method setOutput
void	setOutput(String[] outputArray) Method setOutput
void	setParameter(int index, Parameter vParameter) Method setParameter
void	setParameter(Parameter[] parameterArray) Method setParameter
void	setServiceID(String serviceID) Sets the value of field 'serviceID'.
static Object	unmarshal(Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceSpecification

public ServiceSpecification()

Method Detail

addInput

public void addInput(String vInput)
              throws IndexOutOfBoundsException

Method addInput

Parameters:

vInput -

Throws:

IndexOutOfBoundsException

addInput

public void addInput(int index,
                     String vInput)
              throws IndexOutOfBoundsException

Method addInput

Parameters:

index -

vInput -

Throws:

IndexOutOfBoundsException

addOutput

public void addOutput(String vOutput)
               throws IndexOutOfBoundsException

Method addOutput

Parameters:

vOutput -

Throws:

IndexOutOfBoundsException

addOutput

public void addOutput(int index,
                      String vOutput)
               throws IndexOutOfBoundsException

Method addOutput

Parameters:

index -

vOutput -

Throws:

IndexOutOfBoundsException

addParameter

public void addParameter(Parameter vParameter)
                  throws IndexOutOfBoundsException

Method addParameter

Parameters:

vParameter -

Throws:

IndexOutOfBoundsException

addParameter

public void addParameter(int index,
                         Parameter vParameter)
                  throws IndexOutOfBoundsException

Method addParameter

Parameters:

index -

vParameter -

Throws:

IndexOutOfBoundsException

enumerateInput

public Enumeration enumerateInput()

Method enumerateInput

enumerateOutput

public Enumeration enumerateOutput()

Method enumerateOutput

enumerateParameter

public Enumeration enumerateParameter()

Method enumerateParameter

getErrorStream

public String getErrorStream()

Returns the value of field 'errorStream'.

Returns:

the value of field 'errorStream'.

getInput

public String getInput(int index)
                throws IndexOutOfBoundsException

Method getInput

Parameters:

index -

Throws:

IndexOutOfBoundsException

getInput

public String[] getInput()

Method getInput

getInputCount

public int getInputCount()

Method getInputCount

getOutput

public String getOutput(int index)
                 throws IndexOutOfBoundsException

Method getOutput

Parameters:

index -

Throws:

IndexOutOfBoundsException

getOutput

public String[] getOutput()

Method getOutput

getOutputCount

public int getOutputCount()

Method getOutputCount

getParameter

public Parameter getParameter(int index)
                       throws IndexOutOfBoundsException

Method getParameter

Parameters:

index -

Throws:

IndexOutOfBoundsException

getParameter

public Parameter[] getParameter()

Method getParameter

getParameterCount

public int getParameterCount()

Method getParameterCount

getServiceID

public String getServiceID()

Returns the value of field 'serviceID'.

Returns:

the value of field 'serviceID'.

isValid

public boolean isValid()

Method isValid

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

removeAllInput

public void removeAllInput()

Method removeAllInput

removeAllOutput

public void removeAllOutput()

Method removeAllOutput

removeAllParameter

public void removeAllParameter()

Method removeAllParameter

removeInput

public String removeInput(int index)

Method removeInput

Parameters:

index -

removeOutput

public String removeOutput(int index)

Method removeOutput

Parameters:

index -

removeParameter

public Parameter removeParameter(int index)

Method removeParameter

Parameters:

index -

setErrorStream

public void setErrorStream(String errorStream)

Sets the value of field 'errorStream'.

Parameters:

errorStream - the value of field 'errorStream'.

setInput

public void setInput(int index,
                     String vInput)
              throws IndexOutOfBoundsException

Method setInput

Parameters:

index -

vInput -

Throws:

IndexOutOfBoundsException

setInput

public void setInput(String[] inputArray)

Method setInput

Parameters:

inputArray -

setOutput

public void setOutput(int index,
                      String vOutput)
               throws IndexOutOfBoundsException

Method setOutput

Parameters:

index -

vOutput -

Throws:

IndexOutOfBoundsException

setOutput

public void setOutput(String[] outputArray)

Method setOutput

Parameters:

outputArray -

setParameter

public void setParameter(int index,
                         Parameter vParameter)
                  throws IndexOutOfBoundsException

Method setParameter

Parameters:

index -

vParameter -

Throws:

IndexOutOfBoundsException

setParameter

public void setParameter(Parameter[] parameterArray)

Method setParameter

Parameters:

parameterArray -

setServiceID

public void setServiceID(String serviceID)

Sets the value of field 'serviceID'.

Parameters:

serviceID - the value of field 'serviceID'.

unmarshal

public static Object unmarshal(Reader reader)
                        throws org.exolab.castor.xml.MarshalException,
                               org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException