org.lsst.ccs.gconsole.services.persist

Interface Creator

All Superinterfaces:

HasPath

All Known Implementing Classes:

CreatorExecutable, CreatorFromDescriptor

public interface Creator
extends HasPath

An object that can instantiate a Persistable.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Creator.Descriptor JavaBean that describes an invocation of a Creator.

Method Summary

Modifier and Type	Method and Description
static Object	decode(String encodedValue, Type valueType) Converts a string representation of a parameter value to the actual value.
static String	encode(Object value, Type valueType) Converts a parameter value to its string representation.
String	getCategory() Returns the category this factory belongs to.
String	getDescription() The description of this factory.
String	getName() The name of this factory.
String[]	getParameterDescriptions() The list of the names of the parameters of this factory.
Parameter[]	getParameters() The list of parameters of this factory.
String	getPath() Returns the slash-separated path to this factory.
Persistable	make(Object... parameters) Creates an instance of a Persistable.
Persistable	make(String... parametersAsStrings) Creates an instance of a Persistable.

Method Detail

getCategory

String getCategory()

Returns the category this factory belongs to. The category determines the set of factories the user is prompted to select from when interactively creating a Persistable.

Returns:

Category ID.

getPath

String getPath()

Returns the slash-separated path to this factory. The path determines placement in the tree of factories the user is prompted to select from when interactively creating a Persistable. The path must be unique among factories in the same category.

Specified by:

getPath in interface HasPath

Returns:

Path to this factory.

getName

String getName()

The name of this factory. The name is presented to the user along with the description but is not used internally.

Returns:

Human-readable name.

getDescription

String getDescription()

The description of this factory.

Returns:

Description (html allowed).

getParameters

Parameter[] getParameters()

The list of parameters of this factory.

Returns:

List of parameters.

getParameterDescriptions

String[] getParameterDescriptions()

The list of the names of the parameters of this factory.

Returns:

List of parameter names.

make

Persistable make(Object... parameters)
          throws Exception

Creates an instance of a Persistable. Implementations must ensure that the created instance has correct creator properties set on its descriptor.

Parameters:

parameters - Creator parameters to be used.

Returns:

The created component.

Throws:

Exception - If the instance cannot be created. The exception should indicate the reason for the failure.

make

Persistable make(String... parametersAsStrings)
          throws Exception

Creates an instance of a Persistable. Implementations must ensure that the created instance has correct factory properties set on its descriptor.

Parameters:

parametersAsStrings - String representations of the factory parameters to be used.

Returns:

The created component.

Throws:

Exception - If the instance cannot be created. The exception should indicate the reason for the failure.

encode

static String encode(Object value,
                     Type valueType)

Converts a parameter value to its string representation.

Parameters:

value - Parameter value.

valueType - Parameter type.

Returns:

String representation of the parameter value.

Throws:

IllegalArgumentException - If the provided arguments are incompatible.

decode

static Object decode(String encodedValue,
                     Type valueType)

Converts a string representation of a parameter value to the actual value.

Parameters:

encodedValue - String representation of a parameter value.

valueType - Parameter type.

Returns:

Parameter value.

Throws:

IllegalArgumentException - If the provided string cannot be converted to an object of the specified type.