Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.hivemind.schema
Interface SchemaProcessor  view SchemaProcessor download SchemaProcessor.java


public interface SchemaProcessor

Object used when processing the elements contributed in an org.apache.hivemind.internal.Contribution.


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.
 org.apache.hivemind.internal.Module getContributingModule()
          Returns the module which contributed the current elements being processed.
 org.apache.hivemind.internal.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

public 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 org.apache.hivemind.schema.rules.InvokeParentRule to add themselves to the list of elements for the org.apache.hivemind.internal.ConfigurationPoint being constructed.


push

public void push(java.lang.Object object)
Pushes an object onto the processor's stack.


pop

public java.lang.Object pop()
Pops the top object off the stack and returns it.


peek

public java.lang.Object peek()
Peeks at the top object on the stack.


peek

public java.lang.Object peek(int depth)
Peeks at an object within the stack at the indicated depth.


getContributingModule

public org.apache.hivemind.internal.Module getContributingModule()
Returns the module which contributed the current elements being processed.


getDefiningModule

public org.apache.hivemind.internal.Module getDefiningModule()
Return the module which defined the schema.

Since:
1.1

getElementPath

public 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

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


getAttributeTranslator

public Translator getAttributeTranslator(java.lang.String attributeName)
Returns the Translator for a particular attribute of the current element. Will not return null.


getTranslator

public Translator getTranslator(java.lang.String translator)
Returns the named Translator.