Class FunctionXML_XELEMENT
- java.lang.Object
-
- com.igormaznitsa.jcp.expression.functions.AbstractFunction
-
- com.igormaznitsa.jcp.expression.functions.xml.AbstractXMLFunction
-
- com.igormaznitsa.jcp.expression.functions.xml.FunctionXML_XELEMENT
-
- All Implemented Interfaces:
ExpressionItem
public final class FunctionXML_XELEMENT extends AbstractXMLFunction
The class implements the xml_xpathelement function handler
-
-
Field Summary
Fields Modifier and Type Field Description private static ValueType[][]
ARG_TYPES
-
Fields inherited from class com.igormaznitsa.jcp.expression.functions.AbstractFunction
ALL_FUNCTIONS, EXECUTION_PREFIX, FUNCTION_NAME_MAP, UID_COUNTER
-
-
Constructor Summary
Constructors Constructor Description FunctionXML_XELEMENT()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Value
executeStrStr(PreprocessorContext context, Value documentId, Value xPath)
ValueType[][]
getAllowedArgumentTypes()
Get arrays of supported argument typesint
getArity()
Get the function arityjava.lang.String
getName()
Get the function namejava.lang.String
getReference()
Get the function reference to be output for a help requestValueType
getResultType()
Get the result typeprivate javax.xml.xpath.XPathExpression
prepareXPathExpression(java.lang.String path)
-
Methods inherited from class com.igormaznitsa.jcp.expression.functions.xml.AbstractXMLFunction
buildPathForElement, findCachedElement, findCachedElementList, findElementForIndex, getAttribute, getCachedDocument, getCachedElement, getCachedElementList, getElementListSize, getFirstLevelTextContent, makeDocumentId, makeDocumentRootId, makeElementId, makeElementListId, makeXPathElementId, makeXPathListId
-
Methods inherited from class com.igormaznitsa.jcp.expression.functions.AbstractFunction
findForClass, findForName, getExpressionItemPriority, getExpressionItemType, toString
-
-
-
-
Field Detail
-
ARG_TYPES
private static final ValueType[][] ARG_TYPES
-
-
Method Detail
-
getName
public java.lang.String getName()
Description copied from class:AbstractFunction
Get the function name- Specified by:
getName
in classAbstractFunction
- Returns:
- the function name in lower case, must not be null
-
executeStrStr
public Value executeStrStr(PreprocessorContext context, Value documentId, Value xPath)
-
prepareXPathExpression
private javax.xml.xpath.XPathExpression prepareXPathExpression(java.lang.String path) throws javax.xml.xpath.XPathExpressionException
- Throws:
javax.xml.xpath.XPathExpressionException
-
getArity
public int getArity()
Description copied from class:AbstractFunction
Get the function arity- Specified by:
getArity
in classAbstractFunction
- Returns:
- the function arity (zero or greater)
-
getAllowedArgumentTypes
@MustNotContainNull public ValueType[][] getAllowedArgumentTypes()
Description copied from class:AbstractFunction
Get arrays of supported argument types- Specified by:
getAllowedArgumentTypes
in classAbstractFunction
- Returns:
- the array of argument type combinations allowed by the function handler, must not be null
-
getReference
public java.lang.String getReference()
Description copied from class:AbstractFunction
Get the function reference to be output for a help request- Specified by:
getReference
in classAbstractFunction
- Returns:
- the function information as a String, must not be null
-
getResultType
public ValueType getResultType()
Description copied from class:AbstractFunction
Get the result type- Specified by:
getResultType
in classAbstractFunction
- Returns:
- the result type of the function, must not be null
-
-