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

java.lang.Object
  nz.ac.waikato.mcennis.rat.AbstractFactory<IODescriptorInternal>
      nz.ac.waikato.mcennis.rat.graph.descriptors.IODescriptorFactory

public class IODescriptorFactory
extends AbstractFactory<IODescriptorInternal>

Class for generating descriptors from a Properties map.

Field Summary

static boolean

isInitialized

Fields inherited from class nz.ac.waikato.mcennis.rat.AbstractFactory

map, properties

Method Summary

IODescriptorInternal	create(IODescriptor.Type type, java.lang.String algorithm, java.lang.String relation, Query query, java.lang.String property, java.lang.String description)
IODescriptorInternal	create(IODescriptor.Type type, java.lang.String algorithm, java.lang.String relation, Query query, java.lang.String property, java.lang.String description, boolean appendGraphID)
IODescriptorInternal	create(IODescriptor.Type type, java.lang.String algorithm, java.lang.String relation, Query query, java.lang.String property, java.lang.String description, boolean appendGraphID, Properties props)
IODescriptorInternal	create(IODescriptor.Type type, java.lang.String algorithm, java.lang.String relation, Query query, java.lang.String property, java.lang.String description, Properties props)
IODescriptorInternal	create(Properties props) Create the given object using the settings in the Properties object.
Parameter	getClassParameter() Return the parameter containing the name of the default type produced by this object.
static void	initialization()
static IODescriptorFactory	newInstance() Create a new reference to a singelton DescriptorFactory object

Methods inherited from class nz.ac.waikato.mcennis.rat.AbstractFactory

addDefaultProperty, addType, check, check, getKnownTypes, getParameter, getParameter, setDefaultProperty

Methods inherited from class java.lang.Object

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

Field Detail

isInitialized

public static boolean isInitialized

Method Detail

newInstance

public static IODescriptorFactory newInstance()

Create a new reference to a singelton DescriptorFactory object

Returns:

reference to the Factory.

initialization

public static void initialization()

create

public IODescriptorInternal create(IODescriptor.Type type,
                                   java.lang.String algorithm,
                                   java.lang.String relation,
                                   Query query,
                                   java.lang.String property,
                                   java.lang.String description)

create

public IODescriptorInternal create(IODescriptor.Type type,
                                   java.lang.String algorithm,
                                   java.lang.String relation,
                                   Query query,
                                   java.lang.String property,
                                   java.lang.String description,
                                   boolean appendGraphID)

create

public IODescriptorInternal create(IODescriptor.Type type,
                                   java.lang.String algorithm,
                                   java.lang.String relation,
                                   Query query,
                                   java.lang.String property,
                                   java.lang.String description,
                                   Properties props)

create

public IODescriptorInternal create(IODescriptor.Type type,
                                   java.lang.String algorithm,
                                   java.lang.String relation,
                                   Query query,
                                   java.lang.String property,
                                   java.lang.String description,
                                   boolean appendGraphID,
                                   Properties props)

create

public IODescriptorInternal create(Properties props)

Description copied from class: AbstractFactory

Create the given object using the settings in the Properties object. This function is the only global creation object, but each factory should also define a more user-friendly version consisting of a set of commonly used creation parameters as well as a version combining commonly used features with a Properties object. The property may be null. if the creation fails, the factory should log to the Logger the explanation and return null. If at all possible, the factory should provide a reasonable fail-over value rather than return null.

Specified by:

create in class AbstractFactory<IODescriptorInternal>

Parameters:

props - parameters used to control the factory.

Returns:

newly created object or null

getClassParameter

public Parameter getClassParameter()

Description copied from class: AbstractFactory

Return the parameter containing the name of the default type produced by this object. The parameter will have exactly one value of type String. The type name of this parameter is the type that controls which class of object is produced.

Specified by:

getClassParameter in class AbstractFactory<IODescriptorInternal>

Returns:

parameter containing the default type.