oracle.adfdt.view.common.binding.creator.v2

Class BaseBinder2<O extends PatternOptions>

java.lang.Object

oracle.adfdt.view.common.binding.creator.v2.BaseBinder2<O>

All Implemented Interfaces:

Binder2<O>

Direct Known Subclasses:

AreaChartPattern, AreaGraphPattern, AttributeGroupsPattern, BarChartPattern, BarGraphPattern, BarGraphThemePattern, BasePattern, BubbleChartPattern, BubbleGraphPattern, ColorThemePattern, ComboChartPattern, ComboGraphPattern, DialGaugePattern, FunnelChartPattern, FunnelGraphPattern, GaugePattern, HorizontalBarChartPattern, HorizontalBarGraphPattern, LedGaugePattern, LineChartPattern, LineGraphPattern, MapPattern, MarkerPattern, NBoxPattern, ParetoGraphPattern, PictoChartPattern, PieChartPattern, PieGraphPattern, PieGraphThemePattern, PivotTablePattern, PointThemePattern, RadarGraphPattern, RatingGaugePattern, ScatterChartPattern, ScatterGraphPattern, SparkChartPattern, StatusMeterGaugePattern, StockChartPattern, StockGraphPattern, TagCloudPattern, TimeAxisPattern, TimelineItemPattern, TimelineOverviewPattern, TimelinePattern, TimelineSeriesPattern, TreemapPattern

public abstract class BaseBinder2<O extends PatternOptions>
extends java.lang.Object
implements Binder2<O>

A convenience class for Binders that have simple rebind checking, and do not provide an options configurator.

Constructor Summary

Constructors

Constructor and Description
BaseBinder2()

Method Summary

Modifier and Type	Method and Description
abstract BinderResult	bind(BinderParams<O> params) To be implemented by subclasses.
boolean	canRebind(org.w3c.dom.Node parent, org.w3c.dom.Node toBind) By default, Binders have the option of checking the DOM tree further to see if they can be bound to it.
O	generateOptions(BinderParams<O> params) Binders can provide an options class that can be used to configure the environment based on what is already there.
protected org.w3c.dom.Element	getSingleBindRoot(org.w3c.dom.Node bindRoots) Convenience method to return a single element from the set of bind roots.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseBinder2

public BaseBinder2()

Method Detail

bind

public abstract BinderResult bind(BinderParams<O> params)

To be implemented by subclasses. See Binder2 for API usage.

Specified by:

bind in interface Binder2<O extends PatternOptions>

Parameters:

params - See BinderParams for a complete list

Returns:

Typically just one of the convenience classes in BinderResult

canRebind

public boolean canRebind(org.w3c.dom.Node parent,
                         org.w3c.dom.Node toBind)

By default, Binders have the option of checking the DOM tree further to see if they can be bound to it. However, the framework will first already check the node signature of the defined pattern, and for many cases, this is sufficient. Subclasses that do override this should be sure to also override the annotation on the class, such that: @SimpleRebindChecking(true)

Specified by:

canRebind in interface Binder2<O extends PatternOptions>

Parameters:

parent - The parent of the nodes to be bound

toBind - The nodes to bind. Typically either a DocumentFragment or Element

Returns:

boolean true or false if binder knoows how to bind the node

generateOptions

public O generateOptions(BinderParams<O> params)

Binders can provide an options class that can be used to configure the environment based on what is already there. Most binders do not support this however. The framework will never call this method.

Specified by:

generateOptions in interface Binder2<O extends PatternOptions>

Parameters:

params - See BinderParams for a complete list

Returns:

An instance of PatternOptions with the current options set, or null if not supported

getSingleBindRoot

protected org.w3c.dom.Element getSingleBindRoot(org.w3c.dom.Node bindRoots)

Convenience method to return a single element from the set of bind roots. This is only applicable and useful for binders that are expecting to bind a single element rooted subtree. Specifically, if the bind roots is a document element, the first child (if it's an element) will be returned. If the bind roots is a single element already, that will just be returned. Anything else will return null.

Parameters:

bindRoots - binding roots

Returns:

element