org.enhydra.zeus
Interface Binder

All Known Implementing Classes:
BaseBinder

public interface Binder

Binder provides an interface for all constraint representations to use. It defines the contract for conversion between an arbitrary constraint representation (XML Schema, DTD, Relax schema, etc) to a set of Zeus Bindings.

This interface also provides uniformity in the overall handling of constraints; in other words, dealing with an XML Schema is generally fundamentally different than dealing with a DTD. However, working with a DTDBinder is identical, from an external perspective, to working with a SchemaBinder.

Version:
1.0
Author:
Brett McLaughlin, Maciej Zawadzki

Method Summary
 java.util.List getBindings()
           This is integral portion of the Binder.
 java.lang.String getNamePrefix()
           This method allows the developer to get the prefix that will be prepended to the name of every generated interface and class.
 boolean isCollapsingSimpleElements()
           This method allows the developer to determine whether all simple XML elements (elements with #PCDATA content) will be mapped to data members on parent member classes rather than their own classes.
 void setCollapseSimpleElements(boolean collapseSimpleElements)
           This method allows the developer to specify that all simple XML elements (elements with #PCDATA content) should map to data members on parent member classes rather than their own classes.
 void setNamePrefix(java.lang.String namePrefix)
           This method allows the developer to set a prefix that will be prepended to the name of every generated interface and class.
 

Method Detail

setNamePrefix

public void setNamePrefix(java.lang.String namePrefix)

This method allows the developer to set a prefix that will be prepended to the name of every generated interface and class.

Parameters:
String - prefix that will be prepended to the name of every generated interface and class

getNamePrefix

public java.lang.String getNamePrefix()

This method allows the developer to get the prefix that will be prepended to the name of every generated interface and class. Returns an empty string in the case that a prefix is not prepended.

Returns:
String prefix that will be prepended to the name of every generated interface and class

setCollapseSimpleElements

public void setCollapseSimpleElements(boolean collapseSimpleElements)

This method allows the developer to specify that all simple XML elements (elements with #PCDATA content) should map to data members on parent member classes rather than their own classes.

Parameters:
collapseSimpleElements - true if simple elements should be collapsed

isCollapsingSimpleElements

public boolean isCollapsingSimpleElements()

This method allows the developer to determine whether all simple XML elements (elements with #PCDATA content) will be mapped to data members on parent member classes rather than their own classes.

Returns:
boolean true if simple elements will be collapsed

getBindings

public java.util.List getBindings()
                           throws java.io.IOException

This is integral portion of the Binder. It is responsible for returning a Zeus representation of the set of constraints that this binding represents, resulting from the input representation (which could be an XML Schema, DTD, Relax schema, etc.).

Returns:
List - the resultant Bindings from conversion of constraints.
Throws:
IOException - when errors in reading input occur.


Copyright © 2001 Enhydra. All Rights Reserved.