Package org.smooks.engine.delivery

Class AbstractContentDeliveryConfig

java.lang.Object

org.smooks.engine.delivery.AbstractContentDeliveryConfig

All Implemented Interfaces:

org.smooks.api.delivery.ContentDeliveryConfig

Direct Known Subclasses:

DOMContentDeliveryConfig, SaxNgContentDeliveryConfig

public abstract class AbstractContentDeliveryConfig
extends Object
implements org.smooks.api.delivery.ContentDeliveryConfig

Abstract ContentDeliveryConfig.

Author:

tom.fennelly@gmail.com

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	closeSink
protected Boolean	closeSource
protected List<org.smooks.api.delivery.event.ContentDeliveryConfigExecutionEvent>	configBuilderEvents	Config builder events list.
protected Boolean	isDefaultSerializationOn
protected Map	objectsTable	Table of Object instance lists keyed by selector.
protected Set<org.smooks.api.lifecycle.PostExecutionLifecycle>	postExecutionLifecycles
protected Set<org.smooks.api.lifecycle.PreExecutionLifecycle>	preExecutionLifecycles
protected org.smooks.api.Registry	registry	Container context.
protected Map<String,List<org.smooks.api.resource.config.ResourceConfig>>	resourceConfigTable	Table of ResourceConfig instances keyed by selector value.

Fields inherited from interface org.smooks.api.delivery.ContentDeliveryConfig

SMOOKS_VISITORS_SORT

Constructor Summary

Constructors

Constructor	Description
AbstractContentDeliveryConfig()

Method Summary

Modifier and Type	Method	Description
<T extends org.smooks.api.resource.visitor.Visitor> void	addToExecutionLifecycleSets(ContentHandlerBindingIndex<T> contentHandlerBindingIndex)
void	executeHandlerCleanup(org.smooks.api.ExecutionContext executionContext)
void	executeHandlerInit(org.smooks.api.ExecutionContext executionContext)
protected boolean	getCloseSink()
protected boolean	getCloseSource()
List<org.smooks.api.delivery.event.ContentDeliveryConfigExecutionEvent>	getContentDeliveryConfigExecutionEvents()
protected org.smooks.api.delivery.FilterBypass	getFilterBypass(ContentHandlerBindingIndex<?>... contentHandlerBindingIndexes)
List<?>	getObjects(String selector)	Get a list Objects from the supplied ResourceConfig selector value.
Map<String,List<org.smooks.api.resource.config.ResourceConfig>>	getResourceConfigs()	Get the ResourceConfig map for the target execution context.
List<org.smooks.api.resource.config.ResourceConfig>	getResourceConfigs(String selector)	Get the list of ResourceConfigs for the specified selector definition.
boolean	isDefaultSerializationOn()
void	setRegistry(org.smooks.api.Registry registry)
void	setResourceConfigs(Map<String,List<org.smooks.api.resource.config.ResourceConfig>> resourceConfigTable)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.smooks.api.delivery.ContentDeliveryConfig

addToExecutionLifecycleSets, getFilterBypass, newFilter, sort

Field Detail

registry

protected org.smooks.api.Registry registry

Container context.

resourceConfigTable

protected Map<String,List<org.smooks.api.resource.config.ResourceConfig>> resourceConfigTable

Table of ResourceConfig instances keyed by selector value. Each table entry contains a List of ResourceConfig instances.

objectsTable

protected final Map objectsTable

Table of Object instance lists keyed by selector. Each table entry contains a List of Objects.

configBuilderEvents

protected final List<org.smooks.api.delivery.event.ContentDeliveryConfigExecutionEvent> configBuilderEvents

Config builder events list.

preExecutionLifecycles

protected final Set<org.smooks.api.lifecycle.PreExecutionLifecycle> preExecutionLifecycles

postExecutionLifecycles

protected final Set<org.smooks.api.lifecycle.PostExecutionLifecycle> postExecutionLifecycles

isDefaultSerializationOn

protected Boolean isDefaultSerializationOn

closeSource

protected Boolean closeSource

closeSink

protected Boolean closeSink

Constructor Detail

AbstractContentDeliveryConfig

public AbstractContentDeliveryConfig()

Method Detail

setRegistry

public void setRegistry(org.smooks.api.Registry registry)

getResourceConfigs

public List<org.smooks.api.resource.config.ResourceConfig> getResourceConfigs(String selector)

Get the list of ResourceConfigs for the specified selector definition.

Specified by:

getResourceConfigs in interface org.smooks.api.delivery.ContentDeliveryConfig

Parameters:

selector - The configuration "selector" attribute value from the .cdrl file in the .cdrar.

Returns:

List of ResourceConfig instances, or null.

setResourceConfigs

public void setResourceConfigs(Map<String,List<org.smooks.api.resource.config.ResourceConfig>> resourceConfigTable)

getResourceConfigs

public Map<String,List<org.smooks.api.resource.config.ResourceConfig>> getResourceConfigs()

Get the ResourceConfig map for the target execution context.

This Map will be preordered for the target execution context.

Specified by:

getResourceConfigs in interface org.smooks.api.delivery.ContentDeliveryConfig

Returns:

ResourceConfig map for the target execution context, keyed by the configuration selector, with each value being a List of preordered ResourceConfig instances.

getObjects

public List<?> getObjects(String selector)

Get a list Objects from the supplied ResourceConfig selector value.

Uses Registry#getObject(ResourceConfig) to construct the object.

Specified by:

getObjects in interface org.smooks.api.delivery.ContentDeliveryConfig

Parameters:

selector - selector attribute value from the .cdrl file in the .cdrar.

Returns:

List of Object instances. An empty list is returned where no selectors exist.

getContentDeliveryConfigExecutionEvents

public List<org.smooks.api.delivery.event.ContentDeliveryConfigExecutionEvent> getContentDeliveryConfigExecutionEvents()

Specified by:

getContentDeliveryConfigExecutionEvents in interface org.smooks.api.delivery.ContentDeliveryConfig

isDefaultSerializationOn

public boolean isDefaultSerializationOn()

Specified by:

isDefaultSerializationOn in interface org.smooks.api.delivery.ContentDeliveryConfig

addToExecutionLifecycleSets

public <T extends org.smooks.api.resource.visitor.Visitor> void addToExecutionLifecycleSets(ContentHandlerBindingIndex<T> contentHandlerBindingIndex)

executeHandlerInit

public void executeHandlerInit(org.smooks.api.ExecutionContext executionContext)

Specified by:

executeHandlerInit in interface org.smooks.api.delivery.ContentDeliveryConfig

executeHandlerCleanup

public void executeHandlerCleanup(org.smooks.api.ExecutionContext executionContext)

Specified by:

executeHandlerCleanup in interface org.smooks.api.delivery.ContentDeliveryConfig

getFilterBypass

protected org.smooks.api.delivery.FilterBypass getFilterBypass(ContentHandlerBindingIndex<?>... contentHandlerBindingIndexes)

getCloseSource

protected boolean getCloseSource()

getCloseSink

protected boolean getCloseSink()