commonj.connector.metadata.build
Interface Binding


public interface Binding

Describes a DataBinding, DataBindingGenerator or FunctionSelector that is provided by the adapter.

Since:
1.1

Field Summary
static int DATABINDING
          Constant indicating DataBinding type.
static int DATABINDINGGENERATOR
          Constant indicating DataBindingGenerator type.
static int DATAHANDLER
          Constant indicating DataHandler type.
static int FUNCTIONSELECTOR
          Constant indicating FunctionSelector type.
static int RECORD
          Constant indicating Record type.
 
Method Summary
 String[] getASINamespaceURI()
          An array of the ASI schema namespaces that are supported by the binding object.
 String getClassName()
          Specifies the fully qualified class name of the DataBinding, DataBindingGenerator, DataHandler or FunctionSelector binding object that is specified.
 String getDescription()
          Returns a description of this binding.
 String getDisplayName()
          Returns a short name that describes the binding.
 int getGeneratedType()
          Returns the output type of the DataBindingGenerator.
 String[] getSupportedType()
          Returns an array of the fully qualified interface or class names that this binding object supports.
 String[] getTags()
          Returns an array of tags which is used for configuration.
 int getType()
          Returns whether this represents a DataBinding, DataBindingGenerator, DataHandler or FunctionSelector.
 

Field Detail

DATABINDING

static final int DATABINDING
Constant indicating DataBinding type.

See Also:
Constant Field Values

FUNCTIONSELECTOR

static final int FUNCTIONSELECTOR
Constant indicating FunctionSelector type.

See Also:
Constant Field Values

DATABINDINGGENERATOR

static final int DATABINDINGGENERATOR
Constant indicating DataBindingGenerator type.

See Also:
Constant Field Values

DATAHANDLER

static final int DATAHANDLER
Constant indicating DataHandler type.

See Also:
Constant Field Values

RECORD

static final int RECORD
Constant indicating Record type.

See Also:
Constant Field Values
Method Detail

getDisplayName

String getDisplayName()
Returns a short name that describes the binding.

This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.

Returns:
a non null String name.
See Also:
ResourceBundle, MessageFormat

getDescription

String getDescription()
Returns a description of this binding.

This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.

Returns:
a non null String description.
See Also:
ResourceBundle, MessageFormat

getClassName

String getClassName()
Specifies the fully qualified class name of the DataBinding, DataBindingGenerator, DataHandler or FunctionSelector binding object that is specified. For example "java.lang.String".

Returns:
Returns the fully qualified name of the DataBinding, DataBindingGenerator, DataHandler or FunctionSelector.

getSupportedType

String[] getSupportedType()
Returns an array of the fully qualified interface or class names that this binding object supports. For example, it may be javax.resource.cci.Streamable. It is used to match the contract for what an adapter requires as specified in the FunctionBuilder.getRecordInterfaces()

Returns:
an array of fully qualified interface or class name that this DataBinding, or output from the DataBindingGenerator, supports.
See Also:
FunctionBuilder.getRecordInterfaces()

getASINamespaceURI

String[] getASINamespaceURI()
An array of the ASI schema namespaces that are supported by the binding object.

Returns:
An array of the ASI schema namespaces that are supported or null.

getType

int getType()
Returns whether this represents a DataBinding, DataBindingGenerator, DataHandler or FunctionSelector. Valid values are Binding.DATABINDING, Binding.DATABINDINGGENERATOR, Binding.DATAHANDLER and Binding.FUNCTIONSELECTOR.

Returns:
the type this binding represents.
See Also:
DATABINDING, FUNCTIONSELECTOR, DATABINDINGGENERATOR, DATAHANDLER

getGeneratedType

int getGeneratedType()
Returns the output type of the DataBindingGenerator. This should only be used when getType() returns Binding.DATABINDINGGENERATOR. Valid values are Binding.DATABINDING and Binding.RECORD.

Returns:
the output type of the DataBindingGenerator.
See Also:
DATABINDING, RECORD

getTags

String[] getTags()
Returns an array of tags which is used for configuration. This would commonly be used with a DataHandler.

Returns:
a String array of tags or null.