Package com.tangosol.coherence.config.xml.preprocessor

Class SchemeRefPreprocessor

java.lang.Object

com.tangosol.coherence.config.xml.preprocessor.SchemeRefPreprocessor

All Implemented Interfaces:

DocumentElementPreprocessor.ElementPreprocessor

public class SchemeRefPreprocessor
extends Object
implements DocumentElementPreprocessor.ElementPreprocessor

A SchemeRefPreprocessor is an DocumentElementPreprocessor.ElementPreprocessor that resolves declarations of <scheme-ref> as required by Coherence.

Since:

Coherence 12.1.2

Author:

bo 2011.08.03

Field Summary

Fields

Modifier and Type	Field	Description
static SchemeRefPreprocessor	INSTANCE	This singleton instance of the SchemeRefPreprocessor.

Constructor Summary

Constructors

Constructor	Description
SchemeRefPreprocessor()

Method Summary

Modifier and Type	Method	Description
XmlElement	findCachingScheme(String sSchemeName, XmlElement element)	Obtains the XmlElement that contains a <scheme-name> definition for the specified sSchemeName with in the provided XmlElement, or null if not found.
boolean	preprocess(ProcessingContext context, XmlElement element)	Process an XmlElement, optionally mutating it (or it's children) if required.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final SchemeRefPreprocessor INSTANCE

This singleton instance of the SchemeRefPreprocessor.

Constructor Detail

SchemeRefPreprocessor

public SchemeRefPreprocessor()

Method Detail

preprocess

public boolean preprocess(ProcessingContext context,
                          XmlElement element)
                   throws ConfigurationException

Process an XmlElement, optionally mutating it (or it's children) if required.

Note: An implementation of this interface should avoid attempting to traverse child XmlElements. If you wish to manually traverse or change the entire document, you should instead use a DocumentPreprocessor.

Specified by:

preprocess in interface DocumentElementPreprocessor.ElementPreprocessor

Parameters:

context - the ProcessingContext in which the pre-processing is occurring

element - the XmlElement to preprocess

Returns:

true if the specified XmlElement should be re-preprocessed by this and other DocumentElementPreprocessor.ElementPreprocessors due to the XmlElement being modified, false otherwise.

Throws:

ConfigurationException - if during pre-processing of the XmlElement a configuration issue was discovered (or if pre-processing fails for some reason)

findCachingScheme

public XmlElement findCachingScheme(String sSchemeName,
                                    XmlElement element)

Obtains the XmlElement that contains a <scheme-name> definition for the specified sSchemeName with in the provided XmlElement, or null if not found.

Parameters:

sSchemeName - The scheme name to locate

element - The XmlElement to search

Returns:

the caching scheme xml element