org.opentox.toxotis.core.component
Class HttpParameter

java.lang.Object
  extended by org.opentox.toxotis.core.OTComponent<HttpParameter>
      extended by org.opentox.toxotis.core.component.HttpParameter
All Implemented Interfaces:
Serializable, IOTComponent, IStAXWritable

public class HttpParameter
extends OTComponent<HttpParameter>

An HTTP parameter is a component that defines the parameters expected from the client on a POST request. Every web service through its RDF representation, defined which parameters it expects, whether these are optional or mandatory and provide some information about them.

Author:
Pantelis Sopasakis, Charalampos Chomenides
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.opentox.toxotis.core.OTComponent
meta, RDF_ABOUT, RDF_RDF, RDF_RESOURCE, RDF_TYPE
 
Constructor Summary
HttpParameter()
           
HttpParameter(VRI uri)
           
 
Method Summary
 HttpParameter addInputParamClass(OntologicalClass... inputParamClass)
           
 HttpParameter addParamContent(OntologicalClass... paramContents)
           
 com.hp.hpl.jena.ontology.Individual asIndividual(com.hp.hpl.jena.ontology.OntModel model)
          The OpenTox component as an individual.
 Set<OntologicalClass> getInputParamClass()
           
 Set<OntologicalClass> getParamContent()
           
 String getParamName()
           
 boolean isOpentoxParameter()
           
 boolean isParamOptional()
           
 HttpParameter setInputParamClass(Set<OntologicalClass> inputParamClass)
           
 HttpParameter setOpentoxParameter(boolean opentoxParameter)
           
 HttpParameter setParamContent(Set<OntologicalClass> paramContent)
           
 HttpParameter setParamName(String paramName)
           
 HttpParameter setParamOptional(boolean paramOptional)
           
 void writeRdf(XMLStreamWriter writer)
          Due to the large size of some objects like datasets, it is advisable to use this method for serializing large objects to RDF/XML rather than the method OntModel#write(OutputStream).
 
Methods inherited from class org.opentox.toxotis.core.OTComponent
addOntologicalClasses, asOntModel, endRdfWriter, equals, getMeta, getOntologicalClasses, getUri, hashCode, initRdfWriter, isEnabled, setEnabled, setMeta, setOntologicalClasses, setUri, writeAnnotationProperty, writeClass, writeDatatypeProperty, writeMetaDataProperties, writeObjectProperty, writeRdf, writeRdf, writeSuperClassRelationships
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HttpParameter

public HttpParameter()

HttpParameter

public HttpParameter(VRI uri)
Method Detail

isOpentoxParameter

public boolean isOpentoxParameter()

setOpentoxParameter

public HttpParameter setOpentoxParameter(boolean opentoxParameter)

getParamContent

public Set<OntologicalClass> getParamContent()

setParamContent

public HttpParameter setParamContent(Set<OntologicalClass> paramContent)

addParamContent

public HttpParameter addParamContent(OntologicalClass... paramContents)

getInputParamClass

public Set<OntologicalClass> getInputParamClass()

setInputParamClass

public HttpParameter setInputParamClass(Set<OntologicalClass> inputParamClass)

addInputParamClass

public HttpParameter addInputParamClass(OntologicalClass... inputParamClass)

isParamOptional

public boolean isParamOptional()

setParamOptional

public HttpParameter setParamOptional(boolean paramOptional)

getParamName

public String getParamName()

setParamName

public HttpParameter setParamName(String paramName)

asIndividual

public com.hp.hpl.jena.ontology.Individual asIndividual(com.hp.hpl.jena.ontology.OntModel model)
Description copied from interface: IOTComponent
The OpenTox component as an individual.

Parameters:
model - The ontological model to which the individual belongs.
Returns:
The OpenTox component as an individual of a data model.

writeRdf

public void writeRdf(XMLStreamWriter writer)
              throws XMLStreamException
Description copied from interface: IStAXWritable
Due to the large size of some objects like datasets, it is advisable to use this method for serializing large objects to RDF/XML rather than the method OntModel#write(OutputStream). In the case of Datasets, it has been shown that this method performs much faster (about 7,5 times faster on a dataset of 21 features and 1000 compounds).

Parameters:
writer - XML Stream Writer used for the serialization of the dataset object.
Throws:
XMLStreamException - In case the serialization is not possible due to syntax errors.


Copyright © 2011-2012 OpenTox. All Rights Reserved.