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

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

All Implemented Interfaces:

InputDescriptor, InputDescriptorInternal

public class BasicInputDescriptor
extends java.lang.Object
implements InputDescriptorInternal

Class for describing the input that a component requires. Implements the InputDesciptor and InputDescriptorInternal interfaces.

Nested Class Summary

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

InputDescriptor.Type

Constructor Summary

BasicInputDescriptor()
Creates a new instance of BasicInputDescriptor

Method Summary

java.lang.String	getAlgorithmName() Acquire the name of the algorithm that generated this data descriptor.
InputDescriptor.Type	getClassType() what type of object - Graph, Link, Actor, or PathSet - does this object describe.
java.lang.String	getProperty() Name of the property of the object that is utilized.
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 name of the algorithm.
void	setClassType(InputDescriptor.Type t) Change the class of input that is utilized
void	setProperty(java.lang.String s) Change the property name that this algorithm requires as input
void	setRelation(java.lang.String s) Change the relation (type, mode) that this algorithm uses.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicInputDescriptor

public BasicInputDescriptor()

Creates a new instance of BasicInputDescriptor

Method Detail

setProperty

public void setProperty(java.lang.String s)

Description copied from interface: InputDescriptorInternal

Change the property name that this algorithm requires as input

Specified by:

setProperty in interface InputDescriptorInternal

Parameters:

s - name of the new property input that is required.

setClassType

public void setClassType(InputDescriptor.Type t)

Description copied from interface: InputDescriptorInternal

Change the class of input that is utilized

Specified by:

setClassType in interface InputDescriptorInternal

Parameters:

t - new input type.

setRelation

public void setRelation(java.lang.String s)

Description copied from interface: InputDescriptorInternal

Change the relation (type, mode) that this algorithm uses.

Specified by:

setRelation in interface InputDescriptorInternal

Parameters:

s - name of the new relation.

setAlgorithmName

public void setAlgorithmName(java.lang.String s)

Description copied from interface: InputDescriptorInternal

Change the name of the algorithm.

Specified by:

setAlgorithmName in interface InputDescriptorInternal

Parameters:

s - new name of this algorithm.

getAlgorithmName

public java.lang.String getAlgorithmName()

Description copied from interface: InputDescriptor

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 InputDescriptor

Returns:

Algorithm name

getRelation

public java.lang.String getRelation()

Description copied from interface: InputDescriptor

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 InputDescriptor

Returns:

list of input actors that matc

getClassType

public InputDescriptor.Type getClassType()

Description copied from interface: InputDescriptor

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

Specified by:

getClassType in interface InputDescriptor

Returns:

type of graph object

getProperty

public java.lang.String getProperty()

Description copied from interface: InputDescriptor

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.

Specified by:

getProperty in interface InputDescriptor

Returns:

name of the property that this algorithm works on.