org.opentox.toxotis.ontology.collection
Class OTDatatypeProperties

java.lang.Object
  extended by org.opentox.toxotis.ontology.collection.OTDatatypeProperties

public final class OTDatatypeProperties
extends Object

Collection of datatype properties used in OpenTox.

Author:
Pantelis Sopasakis, Charalampos Chomenides

Method Summary
static OTDatatypeProperty acceptValue()
          Datatype property used to link an ot:Nominal with its admissible values.
static OTDatatypeProperty actor()
          The actor of an exceptional event.
static OTDatatypeProperty classificationStatistics()
          Classification statistics.
static OTDatatypeProperty details()
          A detailed message with debugging information returned to the client when an exceptional even occurs.
static OTDatatypeProperty duration()
          The duration of a task.
static OTDatatypeProperty errorCode()
          An error code.
static OTDatatypeProperty errorReportProperty()
          This is a generic property.
static OTDatatypeProperty forName(String name)
          Return a datatype property given its name.
static OTDatatypeProperty hasStatus()
          The property ot:hasStatus assigns status values to Tasks.
static OTDatatypeProperty httpStatus()
          The HTTP status.
static OTDatatypeProperty index()
          An index for a parameter value.
static OTDatatypeProperty message()
          A message returned by an exceptional event providing very essential information about it.
static OTDatatypeProperty paramScope()
           
static OTDatatypeProperty paramValue()
          A parameter value.
static OTDatatypeProperty percentageCompleted()
          The percentage to which a task is complete.
static OTDatatypeProperty resultURI()
          The result URI of a task.
static OTDatatypeProperty units()
          Units of measure.
static OTDatatypeProperty value()
          An actual value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

forName

public static OTDatatypeProperty forName(String name)
                                  throws ToxOtisException
Return a datatype property given its name. The input argument of this method is case sensitive and this in some cases might cause an exception to be thrown. This method performs reflective lookups only once (when invoked for the first time) for efficiency.

Parameters:
name - Name of the datatype property to search for
Returns:
The datatype property that was requested
Throws:
ToxOtisException - In case the requested datatype property is not found in the cache.

hasStatus

public static OTDatatypeProperty hasStatus()
The property ot:hasStatus assigns status values to Tasks. The domain of this property is the ontological class OTClasses#Task() and its range is xsd:string. Acceptable values are RUNNING, COMPLETED, ERROR and CANCELED.

Returns:
The property ot:hasStatus

acceptValue

public static OTDatatypeProperty acceptValue()
Datatype property used to link an ot:Nominal with its admissible values. This property is also used to assign range values to Nominal Features. The domain of this property is the class OTClasses#Nominal() and its range is xsd:string.

Returns:
The datatype property ot:acceptValue

paramScope

public static OTDatatypeProperty paramScope()

paramValue

public static OTDatatypeProperty paramValue()
A parameter value.


resultURI

public static OTDatatypeProperty resultURI()
The result URI of a task.


value

public static OTDatatypeProperty value()
An actual value.


units

public static OTDatatypeProperty units()
Units of measure.


classificationStatistics

public static OTDatatypeProperty classificationStatistics()
Classification statistics.


percentageCompleted

public static OTDatatypeProperty percentageCompleted()
The percentage to which a task is complete.


errorReportProperty

public static OTDatatypeProperty errorReportProperty()
This is a generic property. Subproperties usually used are: ot:actor ot:message, ot:details, ot:httpStatus and ot:errorCode.

Returns:
The error report super-property.

actor

public static OTDatatypeProperty actor()
The actor of an exceptional event.


message

public static OTDatatypeProperty message()
A message returned by an exceptional event providing very essential information about it.


details

public static OTDatatypeProperty details()
A detailed message with debugging information returned to the client when an exceptional even occurs.


httpStatus

public static OTDatatypeProperty httpStatus()
The HTTP status.


errorCode

public static OTDatatypeProperty errorCode()
An error code.


index

public static OTDatatypeProperty index()
An index for a parameter value.


duration

public static OTDatatypeProperty duration()
The duration of a task.



Copyright © 2011-2012 OpenTox. All Rights Reserved.