org.gramar

Interface IGramarContext

All Known Implementing Classes:

GramarContext

public interface IGramarContext

Method Summary

Methods

Modifier and Type	Method and Description
void	addModel(String name, Document model) Adds a secondary DOM to the context and associates the Document object at the root of that model with the given variable name.
void	debug(String message) Log a debug-level message
void	declareTemplatingExtension(String namespace, String extensionId) Associates a platform extension (ID) with a namespace.
void	error(Exception e) Log an error
void	error(String message) Log an error message
String	extensionIdForNamespace(String namespace) Return the extension ID that has been associated with this namespace.
void	free() Frees up any cached resources
IFileStore	getFileStore() Answers the current file store
IGramar	getGramar() Answer the gramar being applied
int	getMaxStatus()
int	getModelAccessCount()
IGramar	getPattern()
IGramarPlatform	getPlatform() Answers the PatternPlatform from which all extensions can be eventually located
Document	getPrimaryModel() Answer the model specified when the context was originally constructed
DefinedTag	getTagDef(String namespace, String tagName) Answers the tag definition with the given name from the extension associated with the given namespace
ITagHandler	getTagHandler(String namespace, String tagName) Answers the tag handler with the given name from the extension associated with the given namespace.
Object	getVariable(String variableName) Answers the value associated with the variable name
XPath	getXPath()
XPathFunction	getXPathFunction(String namespace, String name, int arity) Answers the xpath function that best matches the given name and arity from the extension associated with the given namespace
void	info(String message) Log an informational message
boolean	isExtensionDefined(String extensionId)
String	resolveExpressions(String pattern) Replace substrings delimited by curly brackets with the results of evaluating those substrings as xpath expressions.
boolean	resolveToBoolean(String expression) Resolve the given XPath expression to a boolean value
boolean	resolveToBoolean(String expression, Node sourceNode) Resolve the given XPath expression from the sourceNode to a boolean value
Node	resolveToNode(String expression) Resolve the given XPath expression to a single node
Node	resolveToNode(String expression, Node sourceNode) Resolve the given XPath expression from the sourceNode to a single node
Node[]	resolveToNodes(String expression) Resolve the given XPath expression to an array of nodes
Node[]	resolveToNodes(String expression, Node sourceNode) Resolve the given XPath expression from the sourceNode to an array of nodes
double	resolveToNumber(String expression) Resolve the given XPath expression to a numeric (double) value
double	resolveToNumber(String expression, Node sourceNode) Resolve the given XPath expression from the sourceNode to a numeric (double) value
Object	resolveToObject(String expression) Resolve the given XPath expression to a value and return the correct type of result.
Object	resolveToObject(String expression, Node sourceNode) Resolve the given XPath expression from the source node to a value and return the correct type of result.
String	resolveToString(String expression) Resolve the given XPath expression to a single string
String	resolveToString(String expression, Node sourceNode) Resolve the given XPath expression from the sourceNode to a single string
void	setAttribute(String nodeExpression, String attrName, String value) Sets the attribute on the node (obtained by resolving the nodeExpression) to the specified value
void	setFileStore(IFileStore fileStore) Sets the current file store
void	setGramar(IGramar pattern)
void	setVariable(String variableName, Object value) Sets associates the value with the variable name.
void	unsetVariable(String variableName) Removes the association between the variable name and its value.
void	warning(Exception e) Log a warning
void	warning(String message) Log a warning message

Method Detail

setVariable

void setVariable(String variableName,
               Object value)

Sets associates the value with the variable name. Ignored if the variabe name is null

unsetVariable

void unsetVariable(String variableName)

Removes the association between the variable name and its value. Ignored if the variabe name is null

getVariable

Object getVariable(String variableName)

Answers the value associated with the variable name

setAttribute

void setAttribute(String nodeExpression,
                String attrName,
                String value)
                  throws XPathExpressionException

Sets the attribute on the node (obtained by resolving the nodeExpression) to the specified value

Throws:

XPathExpressionException

resolveExpressions

String resolveExpressions(String pattern)
                          throws XPathExpressionException

Replace substrings delimited by curly brackets with the results of evaluating those substrings as xpath expressions. Return the resulting string.

Throws:

XPathExpressionException

resolveToString

String resolveToString(String expression)
                       throws XPathExpressionException

Resolve the given XPath expression to a single string

Throws:

XPathExpressionException

resolveToString

String resolveToString(String expression,
                     Node sourceNode)
                       throws XPathExpressionException

Resolve the given XPath expression from the sourceNode to a single string

Throws:

XPathExpressionException

resolveToBoolean

boolean resolveToBoolean(String expression)
                         throws XPathExpressionException

Resolve the given XPath expression to a boolean value

Throws:

XPathExpressionException

resolveToBoolean

boolean resolveToBoolean(String expression,
                       Node sourceNode)
                         throws XPathExpressionException

Resolve the given XPath expression from the sourceNode to a boolean value

Throws:

XPathExpressionException

resolveToNumber

double resolveToNumber(String expression)
                       throws XPathExpressionException

Resolve the given XPath expression to a numeric (double) value

Throws:

XPathExpressionException

resolveToNumber

double resolveToNumber(String expression,
                     Node sourceNode)
                       throws XPathExpressionException

Resolve the given XPath expression from the sourceNode to a numeric (double) value

Throws:

XPathExpressionException

resolveToObject

Object resolveToObject(String expression)
                       throws XPathExpressionException

Resolve the given XPath expression to a value and return the correct type of result. If the expression results in a NodeSet of length greater than one then return the first node in the NodeSet. Otherwise if the expression returns a numeric value that is not NaN then return the result as a Double. Otherwise, return the result as a String. Booleans won't be returned because of the difficulty in differentiating between 'false' and true.

Throws:

XPathExpressionException

resolveToObject

Object resolveToObject(String expression,
                     Node sourceNode)
                       throws XPathExpressionException

Resolve the given XPath expression from the source node to a value and return the correct type of result. If the expression results in a NodeSet of length greater than one then return the first node in the NodeSet. Otherwise if the expression returns a numeric value that is not NaN then return the result as a Double. Otherwise, return the result as a String. Booleans won't be returned because of the difficulty in differentiating between 'false' and true.

Throws:

XPathExpressionException

resolveToNode

Node resolveToNode(String expression)
                   throws XPathExpressionException

Resolve the given XPath expression to a single node

Throws:

XPathExpressionException

resolveToNode

Node resolveToNode(String expression,
                 Node sourceNode)
                   throws XPathExpressionException

Resolve the given XPath expression from the sourceNode to a single node

Throws:

XPathExpressionException

resolveToNodes

Node[] resolveToNodes(String expression)
                      throws XPathExpressionException

Resolve the given XPath expression to an array of nodes

Throws:

XPathExpressionException

resolveToNodes

Node[] resolveToNodes(String expression,
                    Node sourceNode)
                      throws XPathExpressionException

Resolve the given XPath expression from the sourceNode to an array of nodes

Throws:

XPathExpressionException

addModel

void addModel(String name,
            Document model)

Adds a secondary DOM to the context and associates the Document object at the root of that model with the given variable name.

getPrimaryModel

Document getPrimaryModel()

Answer the model specified when the context was originally constructed

getGramar

IGramar getGramar()

Answer the gramar being applied

declareTemplatingExtension

void declareTemplatingExtension(String namespace,
                              String extensionId)

Associates a platform extension (ID) with a namespace. References to custom templating tags by namespace (prefix) will resolve to tag handlers in the extension with this ID.

extensionIdForNamespace

String extensionIdForNamespace(String namespace)
                               throws NamespaceNotDefinedException

Return the extension ID that has been associated with this namespace.

Throws:

NamespaceNotDefinedException

getFileStore

IFileStore getFileStore()

Answers the current file store

setFileStore

void setFileStore(IFileStore fileStore)

Sets the current file store

getPlatform

IGramarPlatform getPlatform()

Answers the PatternPlatform from which all extensions can be eventually located

getTagDef

DefinedTag getTagDef(String namespace,
                   String tagName)
                     throws GramarException

Answers the tag definition with the given name from the extension associated with the given namespace

Throws:

GramarException

getTagHandler

ITagHandler getTagHandler(String namespace,
                        String tagName)
                          throws GramarException

Answers the tag handler with the given name from the extension associated with the given namespace. Each call to this method returns a new instance of the tag handler class.

Throws:

GramarException

getXPathFunction

XPathFunction getXPathFunction(String namespace,
                             String name,
                             int arity)
                               throws GramarException

Answers the xpath function that best matches the given name and arity from the extension associated with the given namespace

Throws:

GramarException

isExtensionDefined

boolean isExtensionDefined(String extensionId)

setGramar

void setGramar(IGramar pattern)

getPattern

IGramar getPattern()

warning

void warning(Exception e)

Log a warning

error

void error(Exception e)

Log an error

getXPath

XPath getXPath()

getModelAccessCount

int getModelAccessCount()

debug

void debug(String message)

Log a debug-level message

Parameters:

message - - the text to be written

info

void info(String message)

Log an informational message

Parameters:

message - - the text to be written

warning

void warning(String message)

Log a warning message

Parameters:

message - - the text to be written

error

void error(String message)

Log an error message

Parameters:

message - - the text to be written

free

void free()

Frees up any cached resources

getMaxStatus

int getMaxStatus()