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

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

All Implemented Interfaces:

IODescriptor, IODescriptorInternal

public class BasicIODescriptor
extends java.lang.Object
implements IODescriptorInternal

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

Nested Class Summary

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

IODescriptor.Type

Constructor Summary

BasicIODescriptor()
Creates a new instance of BasicIODescriptor

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.
BasicIODescriptor	prototype()
void	setAlgorithmName(java.lang.String s) Change the name of the algorithm.
void	setAppendGraphID(boolean appendGraphID)
void	setClassType(IODescriptor.Type t) Change the class of input that is utilized
void	setDescription(java.lang.String s)
void	setProperty(java.lang.String s) Change the property name that this algorithm requires as input
void	setQuery(Query q)
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

BasicIODescriptor

public BasicIODescriptor()

Creates a new instance of BasicIODescriptor

Method Detail

appendGraphID

public boolean appendGraphID()

Specified by:

appendGraphID in interface IODescriptor

setAppendGraphID

public void setAppendGraphID(boolean appendGraphID)

Specified by:

setAppendGraphID in interface IODescriptorInternal

setQuery

public void setQuery(Query q)

Specified by:

setQuery in interface IODescriptorInternal

getQuery

public Query getQuery()

Specified by:

getQuery in interface IODescriptor

setProperty

public void setProperty(java.lang.String s)

Description copied from interface: IODescriptorInternal

Change the property name that this algorithm requires as input

Specified by:

setProperty in interface IODescriptorInternal

Parameters:

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

setClassType

public void setClassType(IODescriptor.Type t)

Description copied from interface: IODescriptorInternal

Change the class of input that is utilized

Specified by:

setClassType in interface IODescriptorInternal

Parameters:

t - new input type.

setRelation

public void setRelation(java.lang.String s)

Description copied from interface: IODescriptorInternal

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

Specified by:

setRelation in interface IODescriptorInternal

Parameters:

s - name of the new relation.

setAlgorithmName

public void setAlgorithmName(java.lang.String s)

Description copied from interface: IODescriptorInternal

Change the name of the algorithm.

Specified by:

setAlgorithmName in interface IODescriptorInternal

Parameters:

s - new name of this algorithm.

getAlgorithmName

public java.lang.String getAlgorithmName()

Description copied from interface: IODescriptor

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 IODescriptor

Returns:

Algorithm name

getRelation

public java.lang.String getRelation()

Description copied from interface: IODescriptor

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 IODescriptor

Returns:

list of input actors that matc

getClassType

public IODescriptor.Type getClassType()

Description copied from interface: IODescriptor

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

Specified by:

getClassType in interface IODescriptor

Returns:

type of graph object

getProperty

public java.lang.String getProperty()

Description copied from interface: IODescriptor

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 IODescriptor

Returns:

name of the property that this algorithm works on.

prototype

public BasicIODescriptor prototype()

Specified by:

prototype in interface IODescriptor

Specified by:

prototype in interface IODescriptorInternal

setDescription

public void setDescription(java.lang.String s)

Specified by:

setDescription in interface IODescriptorInternal

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface IODescriptor