TPTP 4.2.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.provisional.fastxpath
Class FastXPathContext

java.lang.Object
  extended byorg.eclipse.tptp.platform.provisional.fastxpath.FastXPathContext

public class FastXPathContext
extends java.lang.Object

A runtime context that passes throught he different org.eclipse.tptp.platform.provisional.fastxpath.EExpression#execute(FastXPathContext)method calls


Field Summary
static int ATTRIBUTES_ONLY
          ATTRIBUTES_ONLY -
static int ATTRIBUTES_ONLY_RECURSIVE
          ATTRIBUTES_ONLY_RECURSIVE -
static int ELEMENTS_AND_ATTRIBUTES
          ELEMENTS_AND_ATTRIBUTES -
static int ELEMENTS_ONLY
          ELEMENTS_ONLY -
static int ELEMENTS_ONLY_RECURSIVE
          ELEMENTS_ONLY_RECURSIVE -
 
Constructor Summary
FastXPathContext()
           
FastXPathContext(java.lang.Object object, IFastXPathEngine api)
           
 
Method Summary
 FastXPathContext createContext(java.lang.Object obj)
           
 FastXPathContext createFreshContext()
           
 java.lang.Object[] get(java.lang.String name)
           
 java.lang.Object[] get(java.lang.String name, int queryType)
           
 java.lang.Object[] getAll(java.lang.String name, int queryType, boolean addObj)
           
 java.lang.Object[] getAncestor(java.lang.String name, int queryType)
           
 java.lang.Object[] getAncestor(java.lang.String name, int queryType, boolean includeSelf)
           
 java.lang.Object[] getAncestorOrSelf(java.lang.String name, int queryType)
           
 java.lang.Object[] getAttribute(java.lang.String name, int queryType)
           
 BindingMetaData getBindingMetaData()
           
 java.lang.Object[] getChild(java.lang.String name, int queryType)
           
 java.lang.Object[] getDescendant(java.lang.String name, int queryType)
           
 java.lang.Object[] getDescendantOrSelf(java.lang.String name, int queryType)
           
 IFastXPathEngine getEngine()
           
 java.lang.Object[] getFollowing(java.lang.String name, int queryType)
           
 java.lang.Object[] getFollowingSibling(java.lang.String name)
           
 java.lang.String getId()
           
 java.lang.Object getObject()
           
 java.lang.Object[] getParent()
           
 java.lang.Object[] getParent(java.lang.Object obj)
           
 java.lang.Object[] getPreceding(java.lang.String name)
           
 java.lang.Object[] getPrecedingSibling(java.lang.String name, int queryType)
           
 java.lang.Object getRootObject()
           
 java.lang.Object[] getSelf()
           
 java.lang.Object[] getSelf(java.lang.String name)
           
 void setBindingMetaData(BindingMetaData metaData)
           
 void setEngine(IFastXPathEngine api)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ELEMENTS_AND_ATTRIBUTES

public static final int ELEMENTS_AND_ATTRIBUTES
ELEMENTS_AND_ATTRIBUTES -

See Also:
Constant Field Values

ELEMENTS_ONLY

public static final int ELEMENTS_ONLY
ELEMENTS_ONLY -

See Also:
Constant Field Values

ELEMENTS_ONLY_RECURSIVE

public static final int ELEMENTS_ONLY_RECURSIVE
ELEMENTS_ONLY_RECURSIVE -

See Also:
Constant Field Values

ATTRIBUTES_ONLY

public static final int ATTRIBUTES_ONLY
ATTRIBUTES_ONLY -

See Also:
Constant Field Values

ATTRIBUTES_ONLY_RECURSIVE

public static final int ATTRIBUTES_ONLY_RECURSIVE
ATTRIBUTES_ONLY_RECURSIVE -

See Also:
Constant Field Values
Constructor Detail

FastXPathContext

public FastXPathContext(java.lang.Object object,
                        IFastXPathEngine api)
Parameters:
object -
api -

FastXPathContext

public FastXPathContext()
Method Detail

createContext

public FastXPathContext createContext(java.lang.Object obj)
Parameters:
obj -
Returns:
new context with obj

createFreshContext

public FastXPathContext createFreshContext()
Returns:
new context

get

public java.lang.Object[] get(java.lang.String name,
                              int queryType)
                       throws ExpressionEvaluationException
Parameters:
name -
queryType -
Returns:
Throws:
ExpressionEvaluationException

get

public java.lang.Object[] get(java.lang.String name)
                       throws ExpressionEvaluationException
Parameters:
name -
Returns:
Throws:
ExpressionEvaluationException

getAll

public java.lang.Object[] getAll(java.lang.String name,
                                 int queryType,
                                 boolean addObj)
                          throws ExpressionEvaluationException
Parameters:
name -
queryType -
addObj -
Returns:
Throws:
ExpressionEvaluationException

getId

public java.lang.String getId()
                       throws ExpressionEvaluationException
Returns:
Throws:
ExpressionEvaluationException

getAttribute

public java.lang.Object[] getAttribute(java.lang.String name,
                                       int queryType)
                                throws ExpressionEvaluationException
Parameters:
name -
queryType -
Returns:
Throws:
ExpressionEvaluationException

getFollowing

public java.lang.Object[] getFollowing(java.lang.String name,
                                       int queryType)
                                throws ExpressionEvaluationException
Parameters:
name -
queryType -
Returns:
Throws:
ExpressionEvaluationException

getFollowingSibling

public java.lang.Object[] getFollowingSibling(java.lang.String name)
                                       throws ExpressionEvaluationException
Parameters:
name -
Returns:
Throws:
ExpressionEvaluationException

getPreceding

public java.lang.Object[] getPreceding(java.lang.String name)
                                throws ExpressionEvaluationException
Parameters:
name -
Returns:
Throws:
ExpressionEvaluationException

getPrecedingSibling

public java.lang.Object[] getPrecedingSibling(java.lang.String name,
                                              int queryType)
                                       throws ExpressionEvaluationException
Parameters:
name -
queryType -
Returns:
Throws:
ExpressionEvaluationException

getDescendant

public java.lang.Object[] getDescendant(java.lang.String name,
                                        int queryType)
                                 throws ExpressionEvaluationException
Parameters:
name -
queryType -
Returns:
Throws:
ExpressionEvaluationException

getDescendantOrSelf

public java.lang.Object[] getDescendantOrSelf(java.lang.String name,
                                              int queryType)
                                       throws ExpressionEvaluationException
Parameters:
name -
queryType -
Returns:
Throws:
ExpressionEvaluationException

getAncestor

public java.lang.Object[] getAncestor(java.lang.String name,
                                      int queryType,
                                      boolean includeSelf)
                               throws ExpressionEvaluationException
Parameters:
name -
queryType -
includeSelf -
Returns:
Throws:
ExpressionEvaluationException

getAncestor

public java.lang.Object[] getAncestor(java.lang.String name,
                                      int queryType)
                               throws ExpressionEvaluationException
Parameters:
name -
queryType -
Returns:
Throws:
ExpressionEvaluationException

getAncestorOrSelf

public java.lang.Object[] getAncestorOrSelf(java.lang.String name,
                                            int queryType)
                                     throws ExpressionEvaluationException
Parameters:
name -
queryType -
Returns:
Throws:
ExpressionEvaluationException

getSelf

public java.lang.Object[] getSelf(java.lang.String name)
                           throws ExpressionEvaluationException
Parameters:
name -
Returns:
obj
Throws:
ExpressionEvaluationException

getSelf

public java.lang.Object[] getSelf()
Returns:
obj

getParent

public java.lang.Object[] getParent()
Returns:
parent

getParent

public java.lang.Object[] getParent(java.lang.Object obj)
Parameters:
obj -
Returns:
parent of obj

getChild

public java.lang.Object[] getChild(java.lang.String name,
                                   int queryType)
                            throws ExpressionEvaluationException
Parameters:
name -
queryType -
Returns:
Throws:
ExpressionEvaluationException

getObject

public java.lang.Object getObject()
Returns:
the object

getRootObject

public java.lang.Object getRootObject()
Returns:
the rootObject

getEngine

public IFastXPathEngine getEngine()
Returns:
the fastXpathEngine

setEngine

public void setEngine(IFastXPathEngine api)
Parameters:
api -

getBindingMetaData

public BindingMetaData getBindingMetaData()
Returns:
the metaData

setBindingMetaData

public void setBindingMetaData(BindingMetaData metaData)
Parameters:
metaData -

TPTP 4.2.0 Platform Project
Public API Specification