org.smooks.cartridges.javabean.binding

Class AbstractBinding

java.lang.Object

org.smooks.cartridges.javabean.binding.AbstractBinding

Direct Known Subclasses:

XMLBinding

public class AbstractBinding
extends Object

Abstract Binding class.

Author:

tom.fennelly@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allConfigsAdded All configurations added flag.
protected boolean	initialized Initialized flag.
protected String	reportPath Execution report path.
protected org.smooks.Smooks	smooks Smooks instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBinding() Constructor.
protected	AbstractBinding(org.smooks.Smooks smooks) Constructor.

Method Summary

Modifier and Type	Method and Description
AbstractBinding	add(InputStream smooksConfigStream) Add Smooks binding configurations to the binding instance.
AbstractBinding	add(String smooksConfigURI) Add Smooks binding configurations to the binding instance.
protected GetterGraph	addToContextualGetter(GetterGraph contextualGetter, Bean bean)
protected void	assertInitialized()
protected void	assertNotAllConfigsAdded()
protected void	assertNotInitialized()
protected <T> T	bind(org.smooks.api.io.Source inputSource, Class<T> toType) Bind the input source to the specified type.
protected GetterGraph	constructContextualGetter(Bean bean)
protected GetterGraph	constructContextualGetter(DataBinding binding)
org.smooks.Smooks	getSmooks() Get the underlying Smooks instance.
protected org.smooks.api.resource.config.ResourceConfigSeq	getUserDefinedResourceList()
AbstractBinding	initialise() Initialize the binding instance.
AbstractBinding	setReportPath(String reportPath) Set the execution report output path.

Methods inherited from class java.lang.Object

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

Field Detail

smooks

protected org.smooks.Smooks smooks

Smooks instance.

reportPath

protected String reportPath

Execution report path.

allConfigsAdded

protected boolean allConfigsAdded

All configurations added flag.

initialized

protected boolean initialized

Initialized flag.

Constructor Detail

AbstractBinding

protected AbstractBinding()

Constructor.

AbstractBinding

protected AbstractBinding(org.smooks.Smooks smooks)

Constructor.

Parameters:

smooks - Smooks instance.

Method Detail

add

public AbstractBinding add(String smooksConfigURI)
                    throws IOException,
                           SAXException

Add Smooks binding configurations to the binding instance.

Parameters:

smooksConfigURI - Smooks configuration.

Throws:

IOException - Error reading resource stream.

SAXException - Error parsing the resource stream.

add

public AbstractBinding add(InputStream smooksConfigStream)
                    throws IOException,
                           SAXException

Add Smooks binding configurations to the binding instance.

Parameters:

smooksConfigStream - Smooks configuration.

Throws:

IOException - Error reading resource stream.

SAXException - Error parsing the resource stream.

initialise

public AbstractBinding initialise()

Initialize the binding instance.

getSmooks

public org.smooks.Smooks getSmooks()

Get the underlying Smooks instance.

Returns:

The underlying Smooks instance.

setReportPath

public AbstractBinding setReportPath(String reportPath)

Set the execution report output path.

Parameters:

reportPath - The execution report output path.

bind

protected <T> T bind(org.smooks.api.io.Source inputSource,
                     Class<T> toType)
              throws IOException

Bind the input source to the specified type.

In order to make a cleaner API, implementing classes should create a more appropriately named method based on the target binding format, that just delegates to this method e.g. XMLBinding#fromXML(javax.xml.transform.Source, Class) and XMLBinding.toXML(Object, java.io.Writer).

Parameters:

inputSource - The input source.

toType - The target type.

Returns:

The target binding type instance.

Throws:

IOException - Error binding source to target type.

getUserDefinedResourceList

protected org.smooks.api.resource.config.ResourceConfigSeq getUserDefinedResourceList()

constructContextualGetter

protected GetterGraph constructContextualGetter(DataBinding binding)

constructContextualGetter

protected GetterGraph constructContextualGetter(Bean bean)

addToContextualGetter

protected GetterGraph addToContextualGetter(GetterGraph contextualGetter,
                                            Bean bean)

assertInitialized

protected void assertInitialized()

assertNotAllConfigsAdded

protected void assertNotAllConfigsAdded()

assertNotInitialized

protected void assertNotInitialized()