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

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

public class DescriptorFactory
extends java.lang.Object

Class for generating descriptors from a Properties map.

Method Summary

InputDescriptorInternal	createInputDescriptor(java.util.Properties props) Creates an input descriptor for the given parameters Class of the input descriptor is determined by the 'Class' property.
OutputDescriptorInternal	createOutputDescriptor(java.util.Properties props) Creates an output descriptor for the given parameters Class of the output descriptor is determined by the 'Class' property.
ParameterInternal	createParameter(java.util.Properties props) Creates a new Parameter object.
static DescriptorFactory	newInstance() Create a new reference to a singelton DescriptorFactory object

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static DescriptorFactory newInstance()

Create a new reference to a singelton DescriptorFactory object

Returns:

reference to the Factory.

createParameter

public ParameterInternal createParameter(java.util.Properties props)

Creates a new Parameter object. The type of parameter is chosen via the key 'Class'

• 'Basic' - BasicParameter
• 'Exponential' - ExponentialDecayParameter
• 'Average' - AverageSumParameter

All parameters take the same additional optional parameters

• 'Name' - sets the name of the parameter
• 'Structural' - sets whether the parameter is structurla or not
• 'Type' - sets the class of this parameter. Reports an error and leaves at the default value if the class is not present in the JVM

Parameters:

props - map of parameters for creating the Object

Returns:

the newly created parameter object.

createInputDescriptor

public InputDescriptorInternal createInputDescriptor(java.util.Properties props)

Creates an input descriptor for the given parameters Class of the input descriptor is determined by the 'Class' property. Currently only the BasicInputDescriptor is created regardless of its value. Other parameters:

• Type - class of input required (see InputDescriptor for description of the types):
  • Actor
  • ActorProperty
  • Graph
  • GraphProperty
  • Link
  • Path
• Relation - string describing the name of the relation (type, mode) of the input.
• Property - string describing the name of the input property.
• AlgorithmName - name of the component that is described by this input descriptor.

Parameters:

props - map of parameters for creating the input descriptor.

Returns:

newly created input descriptor

createOutputDescriptor

public OutputDescriptorInternal createOutputDescriptor(java.util.Properties props)

Creates an output descriptor for the given parameters Class of the output descriptor is determined by the 'Class' property. Currently only the BasicOutputDescriptor is created regardless of its value. Other parameters:

• Type - class of output produced (see OutputDescriptor for description of the types):
  • Actor
  • ActorProperty
  • Graph
  • GraphProperty
  • Link
  • Path
• Relation - string describing the name of the relation (type, mode) of the output.
• Property - string describing the name of the output property.
• AlgorithmName - name of the component that is described by this output descriptor.

Parameters:

props - map of parameters for creating the output descriptor.

Returns:

newly created output descriptor