org.apache.tools.dvsl
Class DVSLNodeContext

java.lang.Object
  extended byorg.apache.velocity.context.InternalContextBase
      extended byorg.apache.velocity.context.AbstractContext
          extended byorg.apache.velocity.VelocityContext
              extended byorg.apache.tools.dvsl.DVSLNodeContext
All Implemented Interfaces:
java.lang.Cloneable, org.apache.velocity.context.Context, org.apache.velocity.context.InternalEventContext, org.apache.velocity.context.InternalHousekeepingContext, java.io.Serializable

class DVSLNodeContext
extends org.apache.velocity.VelocityContext

Context implementation that is the outer context during the transformation. Holds the node stack and also protects the 'special' context elements like 'node'

There are special elements like 'node', which is readonly and corresponds to the current node, and 'attrib', which corresponds to a map of attributes for the current node.

Author:
Geir Magnusson Jr.

Field Summary
private static java.lang.String ATTRIB
          Magic context entity that corresponds to a Map of attributes for the current node
protected  java.util.Map ctx
           
private static java.lang.String NODE
          Magic context entity that corresponds to the current node
private  java.util.Stack nodeStack
          Used to hold the nodes as we get invoked from within the document for applyTemplates() duties
 
Fields inherited from class org.apache.velocity.VelocityContext
 
Fields inherited from class org.apache.velocity.context.AbstractContext
 
Constructor Summary
private DVSLNodeContext()
           
  DVSLNodeContext(org.apache.velocity.context.Context context)
           
 
Method Summary
(package private)  void clearNode()
           
 boolean internalContainsKey(java.lang.Object key)
          determines if there is a value for the given key
 java.lang.Object internalGet(java.lang.String key)
          retrieves value for key from internal storage
 java.lang.Object[] internalGetKeys()
          returns array of keys $$$ GMJ todo
 java.lang.Object internalPut(java.lang.String key, java.lang.Object value)
          stores the value for key to internal storage
 java.lang.Object internalRemove(java.lang.Object key)
          remove a key/value pair from the internal storage
(package private)  DVSLNode peekNode()
           
(package private)  DVSLNode popNode()
           
(package private)  DVSLNode pushNode(DVSLNode n)
           
 
Methods inherited from class org.apache.velocity.VelocityContext
clone
 
Methods inherited from class org.apache.velocity.context.AbstractContext
attachEventCartridge, containsKey, get, getChainedContext, getCurrentResource, getCurrentTemplateName, getEventCartridge, getKeys, getTemplateNameStack, icacheGet, icachePut, popCurrentTemplateName, pushCurrentTemplateName, put, remove, setCurrentResource
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NODE

private static final java.lang.String NODE
Magic context entity that corresponds to the current node

See Also:
Constant Field Values

ATTRIB

private static final java.lang.String ATTRIB
Magic context entity that corresponds to a Map of attributes for the current node

See Also:
Constant Field Values

nodeStack

private java.util.Stack nodeStack
Used to hold the nodes as we get invoked from within the document for applyTemplates() duties


ctx

protected java.util.Map ctx
Constructor Detail

DVSLNodeContext

public DVSLNodeContext(org.apache.velocity.context.Context context)

DVSLNodeContext

private DVSLNodeContext()
Method Detail

internalGet

public java.lang.Object internalGet(java.lang.String key)
retrieves value for key from internal storage

Parameters:
key - name of value to get
Returns:
value as object

internalPut

public java.lang.Object internalPut(java.lang.String key,
                                    java.lang.Object value)
stores the value for key to internal storage

Parameters:
key - name of value to store
value - value to store
Returns:
previous value of key as Object

internalContainsKey

public boolean internalContainsKey(java.lang.Object key)
determines if there is a value for the given key

Parameters:
key - name of value to check
Returns:
true if non-null value in store

internalGetKeys

public java.lang.Object[] internalGetKeys()
returns array of keys $$$ GMJ todo

Returns:
keys as []

internalRemove

public java.lang.Object internalRemove(java.lang.Object key)
remove a key/value pair from the internal storage

Parameters:
key - name of value to remove
Returns:
value removed

pushNode

DVSLNode pushNode(DVSLNode n)

peekNode

DVSLNode peekNode()

popNode

DVSLNode popNode()

clearNode

void clearNode()


Copyright (c) 2001-2002 Apache Software Foundation