org.lsst.ccs.gconsole.services.persist

Class CreatorFromDescriptor

java.lang.Object

org.lsst.ccs.gconsole.services.persist.CreatorFromDescriptor

All Implemented Interfaces:

Creator, HasPath

public class CreatorFromDescriptor
extends Object
implements Creator

Creator that wraps a Persistable.Descriptor.

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.gconsole.services.persist.Creator

Creator.Descriptor

Constructor Summary

Constructors

Constructor and Description
CreatorFromDescriptor(Persistable.Descriptor descriptor)

Method Summary

Modifier and Type	Method and Description
String	getCategory() Returns the category this factory belongs to.
String	getDescription() The description of this factory.
Persistable.Descriptor	getDescriptor()
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.gconsole.services.persist.Creator

decode, encode

Constructor Detail

CreatorFromDescriptor

public CreatorFromDescriptor(Persistable.Descriptor descriptor)

Method Detail

getDescriptor

public Persistable.Descriptor getDescriptor()

getCategory

public String getCategory()

Description copied from interface: Creator

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.

Specified by:

getCategory in interface Creator

Returns:

Category ID.

getPath

public String getPath()

Description copied from interface: Creator

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 Creator

Specified by:

getPath in interface HasPath

Returns:

Path to this factory.

getName

public String getName()

Description copied from interface: Creator

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

Specified by:

getName in interface Creator

Returns:

Human-readable name.

getDescription

public String getDescription()

Description copied from interface: Creator

The description of this factory.

Specified by:

getDescription in interface Creator

Returns:

Description (html allowed).

getParameters

public Parameter[] getParameters()

Description copied from interface: Creator

The list of parameters of this factory.

Specified by:

getParameters in interface Creator

Returns:

List of parameters.

getParameterDescriptions

public String[] getParameterDescriptions()

Description copied from interface: Creator

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

Specified by:

getParameterDescriptions in interface Creator

Returns:

List of parameter names.

make

public Persistable make(Object... parameters)
                 throws Exception

Description copied from interface: Creator

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

Specified by:

make in interface Creator

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

public Persistable make(String... parametersAsStrings)
                 throws Exception

Description copied from interface: Creator

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

Specified by:

make in interface Creator

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.