org.apache.hivemind.schema
Interface SchemaProcessor

All Known Implementing Classes:

SchemaProcessorImpl

public interface SchemaProcessor

Object used when processing the elements contributed in an Contribution.

Author:

Howard Lewis Ship

Method Summary

void	addElement(java.lang.Object element) The SchemaProcessor is always the bottom (deepest) object on the stack.
Translator	getAttributeTranslator(java.lang.String attributeName) Returns the Translator for a particular attribute of the current element.
Translator	getContentTranslator() Returns a Translator used to convert the content of the current element.
Module	getContributingModule() Returns the module which contributed the current elements being processed.
Module	getDefiningModule() Return the module which defined the schema.
java.lang.String	getElementPath() Returns the path to the current element in the form a sequence of element names separated with slashes.
Translator	getTranslator(java.lang.String translator) Returns the named Translator.
java.lang.Object	peek() Peeks at the top object on the stack.
java.lang.Object	peek(int depth) Peeks at an object within the stack at the indicated depth.
java.lang.Object	pop() Pops the top object off the stack and returns it.
void	push(java.lang.Object object) Pushes an object onto the processor's stack.

Method Detail

addElement

void addElement(java.lang.Object element)

The SchemaProcessor is always the bottom (deepest) object on the stack. Top level objects (contained by a schema, not another element) can use an InvokeParentRule to add themselves to the list of elements for the ConfigurationPoint being constructed.

push

void push(java.lang.Object object)

Pushes an object onto the processor's stack.

pop

java.lang.Object pop()

Pops the top object off the stack and returns it.

peek

java.lang.Object peek()

Peeks at the top object on the stack.

peek

java.lang.Object peek(int depth)

Peeks at an object within the stack at the indicated depth.

getContributingModule

Module getContributingModule()

Returns the module which contributed the current elements being processed.

getDefiningModule

Module getDefiningModule()

Return the module which defined the schema.

Since:

1.1

getElementPath

java.lang.String getElementPath()

Returns the path to the current element in the form a sequence of element names separated with slashes. This is most often used in error messages, to help identify the position of an error.

getContentTranslator

Translator getContentTranslator()

Returns a Translator used to convert the content of the current element. Will not return null.

getAttributeTranslator

Translator getAttributeTranslator(java.lang.String attributeName)

Returns the Translator for a particular attribute of the current element. Will not return null.

getTranslator

Translator getTranslator(java.lang.String translator)

Returns the named Translator.