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

All Known Subinterfaces:
OutputDescriptorInternal
All Known Implementing Classes:
BasicOutputDescriptor

public interface OutputDescriptor

Class describing the output types generated by this object. This object remains valid iff not status paramteres are altered. It is the responsibility of the application (or algorithm manager) to ensure that these conditions are met.


Nested Class Summary
static class OutputDescriptor.Type
          Set of all enumerations representing each type of output that an algorithm can produce.
 
Method Summary
 java.lang.String getAlgorithmName()
          Acquire the name of the algorithm that generated this data descriptor.
 OutputDescriptor.Type getClassType()
          what type of object - Graph, Link, or Actor - does this object describe.
 java.lang.String getProperty()
          Name of the property of the object that is created.
 java.lang.String getRelation()
          Return the actor types and link types that this algorithm utilizes during input.
 

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:

getClassType

OutputDescriptor.Type getClassType()
what type of object - Graph, Link, or Actor - does this object describe.

Returns:
is the actor type a graph or not

getProperty

java.lang.String getProperty()
Name of the property of the object that is created. Links objects return null since they can not hold properties.

Returns:
name of the property that this algorithm works on.