nz.ac.waikato.mcennis.rat.graph.descriptors
Interface IODescriptor

All Known Subinterfaces:

IODescriptorInternal

All Known Implementing Classes:

BasicIODescriptor

public interface IODescriptor

Class describing one input parameter of an object. This object is guaranteed to be a valid description of an algorith iff the creating algorithm has no status property changes.

Nested Class Summary

static class

IODescriptor.Type Set of all enumerations representing each type of input that an algorithm can consume.

Method Summary

boolean	appendGraphID()
java.lang.String	getAlgorithmName() Acquire the name of the algorithm that generated this data descriptor.
IODescriptor.Type	getClassType() what type of object - Graph, Link, Actor, or PathSet - does this object describe.
java.lang.String	getDescription()
java.lang.String	getProperty() Name of the property of the object that is utilized.
Query	getQuery()
java.lang.String	getRelation() Return the actor types and link types that this algorithm utilizes during input.
IODescriptor	prototype()

Method Detail

getAlgorithmName

java.lang.String getAlgorithmName()

Acquire the name of the algorithm that generated this data descriptor. Names are unique within a single application, but multiple instances of the same class with differing names are permitted. No set operation defined as it is an immutable object created by the parent algorithm.

Returns:

Algorithm name

getRelation

java.lang.String getRelation()

Return the actor types and link types that this algorithm utilizes during input. This is not necessarily immutable and is no longer valid after any parameter changes.

Returns:

list of input actors that matc

getQuery

Query getQuery()

getClassType

IODescriptor.Type getClassType()

what type of object - Graph, Link, Actor, or PathSet - does this object describe.

Returns:

type of graph object

getProperty

java.lang.String getProperty()

Name of the property of the object that is utilized. This is null if only the existance of the object, not its properties, is utilized. Link objects always return null since they can not hold properties.

Returns:

name of the property that this algorithm works on.

getDescription

java.lang.String getDescription()

prototype

IODescriptor prototype()

appendGraphID

boolean appendGraphID()