org.enhydra.zeus.binding
Class BaseBinding

Direct Known Subclasses:
BaseContainer, BaseProperty, ContainerProperty

public abstract class BaseBinding

Binding represents an arbitrary Java construct, and provides a representation-independent means of showing how a constraint (presumably from an XML Schema, DTD, Relax schema, etc.) maps to Java. It provides a layer of representation between the constraint representation and generated Java.

This implementation of Binding deals with the basic functionality of all bindings. It leaves specific binding implementations to deal with only their functionality.

Author:
Brett McLaughlin
Version: 1.0

Method Summary
 StringgetJavaType()
           This will return the Java type associated with the binding.
 StringgetName()
           This will return the name of the binding.
 voidsetJavaType(String javaType)
           This will set the Java type for this binding.
 voidsetName(String name)
           This will set the name of the binding.

Method Detail

getJavaType

public String getJavaType()

This will return the Java type associated with the binding. This will always be the fully qualified name of the Java object, excepting cases where the object is in default included packages.

For example, an object of type org.bby.Foo would return "org.bby.Foo" when this method is invoked. However, an object of type java.lang.String would only return "String." In all cases, the type returned here is qualified enough to not require any import statements in generated code.

Returns: String - the Java type of the binding.

getName

public String getName()

This will return the name of the binding. This should be the name of the binding, which is most often a variable name.

For example, for a List that is associated with an instance variable named "myList", invoking getName() would return "myList." For a custom object type "Foo", associated with an instance variable "foo", invoking getName() would return "foo".

It's also important to note that there are cases when this would return null. For an object that is top-level, and is not a member variable of any other object, no name will be associated with the binding.

Returns: String - the name of the binding.

setJavaType

public void setJavaType(String javaType)

This will set the Java type for this binding. For more details on Java types and bindings, see getJavaType().

Note: Should this do an internal check in implementations to ensure full qualification, like with Class.forName() or something? If so, notes should be made here to that effect.
Parameters:
javaType - String the Java type for this binding.

setName

public void setName(String name)

This will set the name of the binding. For more details on the name of a binding, see getName().

Parameters:
name - String name of the binding.

Association Links

to Class java.lang.String

The name of the binding

to Class java.lang.String

The Java type of the binding