Java Doc for FuncExtFunction.java in  » XML » xalan » org » apache » xpath » functions » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » XML » xalan » org.apache.xpath.functions 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.xpath.Expression
      org.apache.xpath.functions.Function
         org.apache.xpath.functions.FuncExtFunction

FuncExtFunction
public class FuncExtFunction extends Function (Code)
An object of this class represents an extension call expression. When the expression executes, it calls ExtensionsTable#extFunction, and then converts the result to the appropriate XObject.

Inner Class :class ArgExtOwner implements ExpressionOwner

Field Summary
 Vectorm_argVec
     Array of static expressions which represent the parameters to the function.
 Stringm_extensionName
     The local name of the extension.
 Objectm_methodKey
     Unique method key, which is passed to ExtensionsTable#extFunction in order to allow caching of the method.
 Stringm_namespace
     The namespace for the extension function, which should not normally be null or empty.
final static  longserialVersionUID
    

Constructor Summary
public  FuncExtFunction(java.lang.String namespace, java.lang.String extensionName, Object methodKey)
     Create a new FuncExtFunction based on the qualified name of the extension, and a unique method key.

Method Summary
public  voidcallArgVisitors(XPathVisitor visitor)
     Call the visitors for the function arguments.
public  voidcheckNumberArgs(int argNum)
     Check that the number of arguments passed to this function is correct.
public  XObjectexecute(XPathContext xctxt)
     Execute the function.
public  voidexprSetParent(ExpressionNode n)
     Set the parent node.
public  voidfixupVariables(java.util.Vector vars, int globalsSize)
     This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
Parameters:
  vars - List of QNames that correspond to variables.
public  ExpressiongetArg(int n)
     Return the nth argument passed to the extension function.
Parameters:
  n - The argument number index.
public  intgetArgCount()
     Return the number of arguments that were passed into this extension function.
public  StringgetFunctionName()
     Return the name of the extension function.
public  ObjectgetMethodKey()
     Return the method key of the extension function.
public  StringgetNamespace()
     Return the namespace of the extension function.
protected  voidreportWrongNumberArgs()
     Constructs and throws a WrongNumberArgException with the appropriate message for this function object.
public  voidsetArg(Expression arg, int argNum)
     Set an argument expression for a function.
public  StringtoString()
    

Field Detail
m_argVec
Vector m_argVec(Code)
Array of static expressions which represent the parameters to the function.



m_extensionName
String m_extensionName(Code)
The local name of the extension.



m_methodKey
Object m_methodKey(Code)
Unique method key, which is passed to ExtensionsTable#extFunction in order to allow caching of the method.



m_namespace
String m_namespace(Code)
The namespace for the extension function, which should not normally be null or empty.



serialVersionUID
final static long serialVersionUID(Code)




Constructor Detail
FuncExtFunction
public FuncExtFunction(java.lang.String namespace, java.lang.String extensionName, Object methodKey)(Code)
Create a new FuncExtFunction based on the qualified name of the extension, and a unique method key.
Parameters:
  namespace - The namespace for the extension function, which shouldnot normally be null or empty.
Parameters:
  extensionName - The local name of the extension.
Parameters:
  methodKey - Unique method key, which is passed toExtensionsTable#extFunction in order to allow cachingof the method.




Method Detail
callArgVisitors
public void callArgVisitors(XPathVisitor visitor)(Code)
Call the visitors for the function arguments.



checkNumberArgs
public void checkNumberArgs(int argNum) throws WrongNumberArgsException(Code)
Check that the number of arguments passed to this function is correct.
Parameters:
  argNum - The number of arguments that is being passed to the function.
throws:
  WrongNumberArgsException -



execute
public XObject execute(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)
Execute the function. The function must return a valid object.
Parameters:
  xctxt - The current execution context. A valid XObject.
throws:
  javax.xml.transform.TransformerException -



exprSetParent
public void exprSetParent(ExpressionNode n)(Code)
Set the parent node. For an extension function, we also need to set the parent node for all argument expressions.
Parameters:
  n - The parent node



fixupVariables
public void fixupVariables(java.util.Vector vars, int globalsSize)(Code)
This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
Parameters:
  vars - List of QNames that correspond to variables. This listshould be searched backwards for the first qualified name thatcorresponds to the variable reference qname. The position of theQName in the vector from the start of the vector will be its positionin the stack frame (but variables above the globalsTop value will needto be offset to the current stack frame).NEEDSDOC @param globalsSize



getArg
public Expression getArg(int n)(Code)
Return the nth argument passed to the extension function.
Parameters:
  n - The argument number index. The Expression object at the given index.



getArgCount
public int getArgCount()(Code)
Return the number of arguments that were passed into this extension function. The number of arguments.



getFunctionName
public String getFunctionName()(Code)
Return the name of the extension function. The name of the extension function.



getMethodKey
public Object getMethodKey()(Code)
Return the method key of the extension function. The method key of the extension function.



getNamespace
public String getNamespace()(Code)
Return the namespace of the extension function. The namespace of the extension function.



reportWrongNumberArgs
protected void reportWrongNumberArgs() throws WrongNumberArgsException(Code)
Constructs and throws a WrongNumberArgException with the appropriate message for this function object. This class supports an arbitrary number of arguments, so this method must never be called.
throws:
  WrongNumberArgsException -



setArg
public void setArg(Expression arg, int argNum) throws WrongNumberArgsException(Code)
Set an argument expression for a function. This method is called by the XPath compiler.
Parameters:
  arg - non-null expression that represents the argument.
Parameters:
  argNum - The argument number index.
throws:
  WrongNumberArgsException - If the argNum parameter is beyond whatis specified for this function.



toString
public String toString()(Code)
Return the name of the extesion function in string format



Fields inherited from org.apache.xpath.functions.Function
final static long serialVersionUID(Code)(Java Doc)

Methods inherited from org.apache.xpath.functions.Function
public void callArgVisitors(XPathVisitor visitor)(Code)(Java Doc)
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)(Code)(Java Doc)
public void checkNumberArgs(int argNum) throws WrongNumberArgsException(Code)(Java Doc)
public boolean deepEquals(Expression expr)(Code)(Java Doc)
public XObject execute(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public void postCompileStep(Compiler compiler)(Code)(Java Doc)
protected void reportWrongNumberArgs() throws WrongNumberArgsException(Code)(Java Doc)
public void setArg(Expression arg, int argNum) throws WrongNumberArgsException(Code)(Java Doc)

Methods inherited from org.apache.xpath.Expression
public DTMIterator asIterator(XPathContext xctxt, int contextNode) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public DTMIterator asIteratorRaw(XPathContext xctxt, int contextNode) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public int asNode(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public void assertion(boolean b, java.lang.String msg)(Code)(Java Doc)
public boolean bool(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public boolean canTraverseOutsideSubtree()(Code)(Java Doc)
abstract public boolean deepEquals(Expression expr)(Code)(Java Doc)
public void error(XPathContext xctxt, String msg, Object[] args) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public XObject execute(XPathContext xctxt, int currentNode) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public XObject execute(XPathContext xctxt, int currentNode, DTM dtm, int expType) throws javax.xml.transform.TransformerException(Code)(Java Doc)
abstract public XObject execute(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public XObject execute(XPathContext xctxt, boolean destructiveOK) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public void executeCharsToContentHandler(XPathContext xctxt, ContentHandler handler) throws javax.xml.transform.TransformerException, org.xml.sax.SAXException(Code)(Java Doc)
public void exprAddChild(ExpressionNode n, int i)(Code)(Java Doc)
public ExpressionNode exprGetChild(int i)(Code)(Java Doc)
public int exprGetNumChildren()(Code)(Java Doc)
public ExpressionNode exprGetParent()(Code)(Java Doc)
public void exprSetParent(ExpressionNode n)(Code)(Java Doc)
abstract public void fixupVariables(java.util.Vector vars, int globalsSize)(Code)(Java Doc)
public int getColumnNumber()(Code)(Java Doc)
public ExpressionNode getExpressionOwner()(Code)(Java Doc)
public int getLineNumber()(Code)(Java Doc)
public String getPublicId()(Code)(Java Doc)
public String getSystemId()(Code)(Java Doc)
public boolean isNodesetExpr()(Code)(Java Doc)
final protected boolean isSameClass(Expression expr)(Code)(Java Doc)
public boolean isStableNumber()(Code)(Java Doc)
public double num(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public void warn(XPathContext xctxt, String msg, Object[] args) throws javax.xml.transform.TransformerException(Code)(Java Doc)
public XMLString xstr(XPathContext xctxt) throws javax.xml.transform.TransformerException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.