Inheritance diagram for org.exolab.castor.builder.BindingComponent:

Public Member Functions
boolean	equals (Object object)
String	getCollectionType ()
String	getExtends ()
String[]	getImplements ()
String	getJavaClassName ()
String	getJavaMemberName ()
String	getJavaPackage ()
XSType	getJavaType ()
int	getLowerBound ()
String	getQualifiedName ()
short	getType ()
int	getUpperBound ()
String	getValue ()
String	getValidator ()
String	getXMLFieldHandler ()
boolean	hasBoundProperties ()
boolean	hasEquals ()
int	hashCode ()
boolean	isAbstract ()
boolean	isFinal ()
boolean	useWrapper ()
Static Public Attributes
static final short	INTERFACE = 0
static final short	CLASS = 1
static final short	MEMBER = 2

Detailed Description

This interface is the abstraction of any type of source that can interact with the Source Code Generator. From the Source Code Generator point of view, the source document used to generate Java source code is totally transparent and is not exposed.

Specific implementation of that class will represent the source document used. For instance when generating source code from an XML Schema, the source generator will interact with an org.exolab.castor.builder.binding.XMLBindingComponent whereas when generating source code from an UML model object model, the source generator will interact with an UMLBindingComponent (This is obviously just an example, no UML Object Model has been as of today integrated in Castor).

A binding component can be of three different types:

MEMBER: this type of BindingComponent will represent a java class member.
INTERFACE: this type of BindingComponent will represent a java interface.
CLASS: this type of BindingComponent will represent a java class.

Author:: Arnaud Blandin

Version:

Revision:: 1.1.1.1

Date:: 2003/03/03 07:07:40

Member Function Documentation

boolean org.exolab.castor.builder.BindingComponent.equals ( Object object )

Returns true if the given Object is equal to this instance of BindingComponent.

Returns:: true if the given Object is equal to this instance of BindingComponent.

See also:: java.lang.Object.equals(java.lang.Object)

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

String org.exolab.castor.builder.BindingComponent.getCollectionType ( )

Returns the name of collection type such as 'arraylist' in which we will store the different occurrences of the java member generated to represent that BindingComponent.

Returns:: a string that represents the collection type such as 'arraylist' name in which we will store the different occurrences of the java member generated to represent that BindingComponent.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

String org.exolab.castor.builder.BindingComponent.getExtends ( )

Returns the name of a super class for the current BindingComponent. Null is returned if this BindingComponent is not meant to be mapped to a java class.

Returns:: the name of a super class for the current BindingComponent. Null is returned if this BindingComponent is not meant to be mapped to a java class.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

String [] org.exolab.castor.builder.BindingComponent.getImplements ( )

Returns an array of the different interface names implemented by the class that will represent the current BindingComponent. Null is returned if this BindingComponent is not meant to be mapped to a java class.

Returns:: an array of the different interface names implemented by the class that will represent the current BindingComponent. Null is returned if this BindingComponent is not meant to be mapped to a java class.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

String org.exolab.castor.builder.BindingComponent.getJavaClassName ( )

Returns a valid Java Class Name corresponding to this BindingComponent. This name is not qualified, this is only a local Java class name.

Returns:: a valid Java Class Name corresponding to this BindingComponent. This name is not qualified, this is only a local Java class name.

See also:: getQualifiedName

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

String org.exolab.castor.builder.BindingComponent.getJavaMemberName ( )

Returns a valid Java Member Name corresponding to this BindingComponent. This name is not qualified, this is only a local Java Member name.

Returns:: a valid Java Member Name corresponding to this BindingComponent. This name is not qualified, this is only a local Java member name.

See also:: getQualifiedName

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

String org.exolab.castor.builder.BindingComponent.getJavaPackage ( )

Returns the java package associated with this BindingComponent.

Returns:: the java package associated with this BindingComponent.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

XSType org.exolab.castor.builder.BindingComponent.getJavaType ( )

Returns the XSType that corresponds to the Java type chosen to represent this BindingComponent. An XSType is an abstraction of a Java type used in the Source Generator. It wraps a JType as well as the necessary methods to convert to/from String.

Returns:: an XSType that corresponds to the Java type chosen to represent this BindingComponent.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

int org.exolab.castor.builder.BindingComponent.getLowerBound ( )

Returns the lower bound of the collection that is generated from this BindingComponent. The lower bound is a positive integer.

Returns:: an int representing the lower bound of the collection generated from this BindingComponent.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

String org.exolab.castor.builder.BindingComponent.getQualifiedName ( )

Returns a fully qualified java class name. This name corresponds to the class name that will be generated from this BindingComponent.

Returns:: a fully qualified java class name. This name corresponds to the class name corresponding to this BindingComponent.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

short org.exolab.castor.builder.BindingComponent.getType ( )

Returns the type of this component binding. A component binding can be of three different types:

Interface: it represents the binding to a java interface.
Class: it represents the binding to a java class.
Member: it represents the binding to a java class member.

-1 is returned if the component binding is null.

Returns:

the type of this component binding. A component binding can be of three different types:

Interface: it represents the binding to a java interface.
Class: it represents the binding to a java class.
Member: it represents the binding to a java class member.

-1 is returned if the component binding is null.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

int org.exolab.castor.builder.BindingComponent.getUpperBound ( )

Returns the upper bound of the collection that is generated from this BindingComponent. The upper bound is a positive integer. -1 is returned to indicate that the upper bound is unbounded.

Returns:: an int representing the lower bound of the collection generated from this BindingComponent. -1 is returned to indicate that the upper bound is uinbounded.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

String org.exolab.castor.builder.BindingComponent.getValidator ( )

Returns the fully qualified name of the Validator to use.

Returns:: the fully qualified name of the Validator to use.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

String org.exolab.castor.builder.BindingComponent.getValue ( )

Returns the default value of the member generated from this binding component. The value is returned as its string representation.

Returns:: a string representation of default value for the member generated from this binding component.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

String org.exolab.castor.builder.BindingComponent.getXMLFieldHandler ( )

Returns the fully qualified name of the XMLFieldHandler to use. This handler will be used when generating ClassDescriptors meant to be used in the marshalling framework.

Returns:: the fully qualified name of the XMLFieldHandler to use.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

boolean org.exolab.castor.builder.BindingComponent.hasBoundProperties ( )

Returns true if bound properties must be generated for the class that will represent the current BindingComponent.

Returns:: true if bound properties must be generated for the class the class that will represent the current BindingComponent.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

boolean org.exolab.castor.builder.BindingComponent.hasEquals ( )

Returns true if equal method must be generated for the class that will represent the current BindingComponent.

Returns:: true if equal method must be generated for the class the class that will represent the current BindingComponent.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

int org.exolab.castor.builder.BindingComponent.hashCode ( )

Returns the hashCode value for this object.

Returns:: the hashcode value for this object.

See also:: java.lang.Object.hashcode()

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

boolean org.exolab.castor.builder.BindingComponent.isAbstract ( )

Returns true if the class generated from the current BindingComponent will be abstract.

Returns:: true if the class generated from the current BindingComponent will be abstract.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

boolean org.exolab.castor.builder.BindingComponent.isFinal ( )

Returns true if the class generated from the current BindingComponent will be final.

Returns:: true if the class generated from the current BindingComponent will be final.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

boolean org.exolab.castor.builder.BindingComponent.useWrapper ( )

Returns true if the member represented by that BindingComponent is to be represented by an Object wrapper. For instance an int will be represented by a java Integer if the property is set to true.

Returns:: true if the member represented by that BindingComponent is to be represented by an Object wrapper.

Implemented in org.exolab.castor.builder.binding.XMLBindingComponent.

Member Data Documentation

final short org.exolab.castor.builder.BindingComponent.CLASS = 1 [static]

final short org.exolab.castor.builder.BindingComponent.INTERFACE = 0 [static]

Referenced by org.exolab.castor.builder.binding.XMLBindingComponent.getJavaClassName(), org.exolab.castor.builder.binding.XMLBindingComponent.getJavaMemberName(), and org.exolab.castor.builder.binding.XMLBindingComponent.setView().

final short org.exolab.castor.builder.BindingComponent.MEMBER = 2 [static]

Referenced by org.exolab.castor.builder.binding.XMLBindingComponent.getCollectionType(), org.exolab.castor.builder.binding.XMLBindingComponent.getJavaMemberName(), org.exolab.castor.builder.binding.XMLBindingComponent.getJavaType(), org.exolab.castor.builder.binding.XMLBindingComponent.getValidator(), org.exolab.castor.builder.binding.XMLBindingComponent.getXMLFieldHandler(), and org.exolab.castor.builder.binding.XMLBindingComponent.setView().

The documentation for this interface was generated from the following file:

BindingComponent.java

All Classes Namespaces Files Functions Variables Enumerations Properties

org.exolab.castor.builder.BindingComponent Interface Reference

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation