nz.ac.waikato.mcennis.rat.graph.descriptors
Class BasicOutputDescriptor

java.lang.Object
  nz.ac.waikato.mcennis.rat.graph.descriptors.BasicOutputDescriptor

All Implemented Interfaces:

OutputDescriptor, OutputDescriptorInternal

public class BasicOutputDescriptor
extends java.lang.Object
implements OutputDescriptorInternal

Class for describing the output a component produces. Implements the OutputDescriptor and OutputDescriptorInternal interfaces.

Nested Class Summary

Nested classes/interfaces inherited from interface nz.ac.waikato.mcennis.rat.graph.descriptors.OutputDescriptor

OutputDescriptor.Type

Constructor Summary

BasicOutputDescriptor()
Creates a new instance of BasicOutputDescriptor

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.
void	setAlgorithmName(java.lang.String s) Change the algorithm name attached to this descriptor.
void	setClassType(OutputDescriptor.Type t) Change the type of output generated by this component.
void	setProperty(java.lang.String s) Change the property name modified by this component
void	setRelation(java.lang.String s) Change the relation (type, mode) that this component modifies.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicOutputDescriptor

public BasicOutputDescriptor()

Creates a new instance of BasicOutputDescriptor

Method Detail

setProperty

public void setProperty(java.lang.String s)

Description copied from interface: OutputDescriptorInternal

Change the property name modified by this component

Specified by:

setProperty in interface OutputDescriptorInternal

setClassType

public void setClassType(OutputDescriptor.Type t)

Description copied from interface: OutputDescriptorInternal

Change the type of output generated by this component.

Specified by:

setClassType in interface OutputDescriptorInternal

setRelation

public void setRelation(java.lang.String s)

Description copied from interface: OutputDescriptorInternal

Change the relation (type, mode) that this component modifies.

Specified by:

setRelation in interface OutputDescriptorInternal

setAlgorithmName

public void setAlgorithmName(java.lang.String s)

Description copied from interface: OutputDescriptorInternal

Change the algorithm name attached to this descriptor.

Specified by:

setAlgorithmName in interface OutputDescriptorInternal

getAlgorithmName

public java.lang.String getAlgorithmName()

Description copied from interface: OutputDescriptor

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.

Specified by:

getAlgorithmName in interface OutputDescriptor

Returns:

Algorithm name

getRelation

public java.lang.String getRelation()

Description copied from interface: OutputDescriptor

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.

Specified by:

getRelation in interface OutputDescriptor

Returns:

getClassType

public OutputDescriptor.Type getClassType()

Description copied from interface: OutputDescriptor

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

Specified by:

getClassType in interface OutputDescriptor

Returns:

is the actor type a graph or not

getProperty

public java.lang.String getProperty()

Description copied from interface: OutputDescriptor

Name of the property of the object that is created. Links objects return null since they can not hold properties.

Specified by:

getProperty in interface OutputDescriptor

Returns:

name of the property that this algorithm works on.