Java Doc for UserFunction.java in  » XML » XPath-Saxon » net » sf » saxon » instruct » 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 » XPath Saxon » net.sf.saxon.instruct 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   net.sf.saxon.instruct.Procedure
      net.sf.saxon.instruct.UserFunction

UserFunction
final public class UserFunction extends Procedure implements InstructionInfoProvider(Code)
This object represents the compiled form of a user-written function (the source can be either an XSLT stylesheet function or an XQuery function).

It is assumed that type-checking, of both the arguments and the results, has been handled at compile time. That is, the expression supplied as the body of the function must be wrapped in code to check or convert the result to the required type, and calls on the function must be wrapped at compile time to check or convert the supplied arguments.




Constructor Summary
public  UserFunction()
    
public  UserFunction(Expression body)
    

Method Summary
public  ValueRepresentationcall(ValueRepresentation[] actualArgs, XPathContextMajor context, boolean evaluateTailCalls)
     Call this function.
Parameters:
  actualArgs - the arguments supplied to the function.
public  ValueRepresentationcall(ValueRepresentation[] actualArgs, Controller controller)
     Call this function.
public  SequenceTypegetArgumentType(int n)
    
public  intgetFunctionNameCode()
    
public  InstructionInfogetInstructionInfo()
     Get the InstructionInfo details about the construct.
public  intgetNumberOfArguments()
    
public  UserFunctionParameter[]getParameterDefinitions()
    
public  SequenceTypegetResultType()
    
public  voidsetFunctionNameCode(int nameCode)
    
public  voidsetMemoFunction(boolean isMemo)
    
public  voidsetParameterDefinitions(UserFunctionParameter[] params)
    
public  voidsetResultType(SequenceType resultType)
    
public  voidsetTailRecursive(boolean tailCalls)
    


Constructor Detail
UserFunction
public UserFunction()(Code)



UserFunction
public UserFunction(Expression body)(Code)




Method Detail
call
public ValueRepresentation call(ValueRepresentation[] actualArgs, XPathContextMajor context, boolean evaluateTailCalls) throws XPathException(Code)
Call this function.
Parameters:
  actualArgs - the arguments supplied to the function. These must have the correcttypes required by the function signature (it is the caller's responsibility to check this).It is acceptable to supply a net.sf.saxon.value.Closure to represent a value whoseevaluation will be delayed until it is needed. The array must be the correct size to matchthe number of arguments: again, it is the caller's responsibility to check this.
Parameters:
  context - This provides the run-time context for evaluating the function. It is the caller'sresponsibility to allocate a "clean" context for the function to use; the context that is providedwill be overwritten by the function.
Parameters:
  evaluateTailCalls - if true, then any function calls contained in the body of the functionare evaluated in the normal way, whether or not they are marked as tail calls. If the argumentis false, then tail calls are not evaluated, and instead a FunctionCallPackage is returned containingthe information needed to evaluate the function. The caller must then be prepared to deal with thisreturned value by evaluating the packaged function call (which may return further packaged functioncalls, and so on). a Value representing the result of the function.



call
public ValueRepresentation call(ValueRepresentation[] actualArgs, Controller controller) throws XPathException(Code)
Call this function. This method allows an XQuery function to be called directly from a Java application. It creates the environment needed to achieve this
Parameters:
  actualArgs - the arguments supplied to the function. These must have the correcttypes required by the function signature (it is the caller's responsibility to check this).It is acceptable to supply a net.sf.saxon.value.Closure to represent a value whoseevaluation will be delayed until it is needed. The array must be the correct size to matchthe number of arguments: again, it is the caller's responsibility to check this.
Parameters:
  controller - This provides the run-time context for evaluating the function. A Controllermay be obtained by calling net.sf.saxon.query.XQueryExpression.newController. This maybe used for a series of calls on functions defined in the same module as the XQueryExpression. a Value representing the result of the function.



getArgumentType
public SequenceType getArgumentType(int n)(Code)
Get the required types of an argument to this function
Parameters:
  n - identifies the argument in question, starting at 0 a SequenceType object, indicating the required type of the argument



getFunctionNameCode
public int getFunctionNameCode()(Code)
Get the namepool name code of the function a name code representing the function name



getInstructionInfo
public InstructionInfo getInstructionInfo()(Code)
Get the InstructionInfo details about the construct. This information isn't used for tracing, but it is available when inspecting the context stack.



getNumberOfArguments
public int getNumberOfArguments()(Code)
Get the arity of this function the number of arguments



getParameterDefinitions
public UserFunctionParameter[] getParameterDefinitions()(Code)



getResultType
public SequenceType getResultType()(Code)
Get the type of value returned by this function the declared result type, or the inferred result typeif this is more precise



setFunctionNameCode
public void setFunctionNameCode(int nameCode)(Code)
Set the namepool name code of the function
Parameters:
  nameCode - represents the function name



setMemoFunction
public void setMemoFunction(boolean isMemo)(Code)
Mark this function as a memo function (or not)
Parameters:
  isMemo - true if this is a memo function



setParameterDefinitions
public void setParameterDefinitions(UserFunctionParameter[] params)(Code)



setResultType
public void setResultType(SequenceType resultType)(Code)



setTailRecursive
public void setTailRecursive(boolean tailCalls)(Code)



Methods inherited from net.sf.saxon.instruct.Procedure
final public Expression getBody()(Code)(Java Doc)
public int getColumnNumber()(Code)(Java Doc)
final public Executable getExecutable()(Code)(Java Doc)
public int getLineNumber()(Code)(Java Doc)
public int getLineNumber(int locationId)(Code)(Java Doc)
public LocationProvider getLocationProvider()(Code)(Java Doc)
public String getPublicId()(Code)(Java Doc)
public SlotManager getStackFrameMap()(Code)(Java Doc)
public String getSystemId()(Code)(Java Doc)
public String getSystemId(int locationId)(Code)(Java Doc)
public void setBody(Expression body)(Code)(Java Doc)
public void setExecutable(Executable executable)(Code)(Java Doc)
public void setLineNumber(int lineNumber)(Code)(Java Doc)
public void setStackFrameMap(SlotManager map)(Code)(Java Doc)
public void setSystemId(String systemId)(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.