Java Doc for XQueryFunctionLibrary.java in  » XML » saxonb » net » sf » saxon » query » 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 » saxonb » net.sf.saxon.query 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   net.sf.saxon.query.XQueryFunctionLibrary

XQueryFunctionLibrary
public class XQueryFunctionLibrary implements FunctionLibrary,XQueryFunctionBinder(Code)
An XQueryFunctionLibrary is a function library containing all the user-defined functions available for use within a particular XQuery module: that is, the functions declared in that module, and the functions imported from other modules. It also contains (transiently during compilation) a list of function calls within the module that have not yet been bound to a specific function declaration.



Constructor Summary
public  XQueryFunctionLibrary(Configuration config)
    

Method Summary
public  Expressionbind(int nameCode, String uri, String local, Expression[] arguments)
     Identify a (namespace-prefixed) function appearing in the expression.
public  FunctionLibrarycopy()
     This method creates a copy of a FunctionLibrary: if the original FunctionLibrary allows new functions to be added, then additions to this copy will not affect the original, or vice versa. a copy of this function library.
public  voiddeclareFunction(XQueryFunction function)
    
public  voidexplainGlobalFunctions()
    
protected  voidfixupGlobalFunctions(StaticQueryContext env)
     Fixup all references to global functions.
public  ConfigurationgetConfiguration()
    
public  XQueryFunctiongetDeclaration(int nameCode, String uri, String local, Expression[] staticArgs)
    
public  IteratorgetFunctionDefinitions()
     Get an iterator over the Functions defined in this module an Iterator, whose items are XQueryFunction objects.
public  UserFunctiongetUserDefinedFunction(String uri, String localName, int arity)
     Get the function with a given name and arity.
public  booleanisAvailable(int fingerprint, String uri, String local, int arity)
     Test whether a function with a given name and arity is available.
public  voidsetConfiguration(Configuration config)
    


Constructor Detail
XQueryFunctionLibrary
public XQueryFunctionLibrary(Configuration config)(Code)
Create an XQueryFunctionLibrary




Method Detail
bind
public Expression bind(int nameCode, String uri, String local, Expression[] arguments) throws XPathException(Code)
Identify a (namespace-prefixed) function appearing in the expression. This method is called by the XQuery parser to resolve function calls found within the query.

Note that a function call may appear earlier in the query than the definition of the function to which it is bound. Unlike XSLT, we cannot search forwards to find the function definition. Binding of function calls is therefore a two-stage process; at the time the function call is parsed, we simply register it as pending; subsequently at the end of query parsing all the pending function calls are resolved. Another consequence of this is that we cannot tell at the time a function call is parsed whether it is a call to an internal (XSLT or XQuery) function or to an extension function written in Java. an Expression representing the function call. This will normally bea FunctionCall, but it may be rewritten as some other expression.
throws:
  XPathException - if the function call is invalid, either because it isan unprefixed call to a non-system function, or because it is calling a systemfunction that is available in XSLT only. A prefixed function call that cannotbe recognized at this stage is assumed to be a forwards reference, and is boundlater when bindUnboundFunctionCalls() is called.




copy
public FunctionLibrary copy()(Code)
This method creates a copy of a FunctionLibrary: if the original FunctionLibrary allows new functions to be added, then additions to this copy will not affect the original, or vice versa. a copy of this function library. This must be an instance of the original class.



declareFunction
public void declareFunction(XQueryFunction function) throws StaticError(Code)
Register a user-defined XQuery function



explainGlobalFunctions
public void explainGlobalFunctions() throws XPathException(Code)
Output "explain" information about each declared function



fixupGlobalFunctions
protected void fixupGlobalFunctions(StaticQueryContext env) throws XPathException(Code)
Fixup all references to global functions. This method is called on completion of query parsing. Each XQueryFunction is required to bind all references to that function to the object representing the run-time executable code of the function.

This method is for internal use.




getConfiguration
public Configuration getConfiguration()(Code)
Get the Configuration options



getDeclaration
public XQueryFunction getDeclaration(int nameCode, String uri, String local, Expression[] staticArgs)(Code)
Get the function declaration corresponding to a given function name and arity the XQueryFunction if there is one, or null if not.



getFunctionDefinitions
public Iterator getFunctionDefinitions()(Code)
Get an iterator over the Functions defined in this module an Iterator, whose items are XQueryFunction objects. It returnsall function known to this module including those imported from elsewhere; theycan be distinguished by their namespace.



getUserDefinedFunction
public UserFunction getUserDefinedFunction(String uri, String localName, int arity)(Code)
Get the function with a given name and arity. This method is provided so that XQuery functions can be called directly from a Java application. Note that there is no type checking or conversion of arguments when this is done: the arguments must be provided in exactly the form that the function signature declares them.
Parameters:
  uri - the uri of the function name
Parameters:
  localName - the local part of the function name
Parameters:
  arity - the number of arguments.



isAvailable
public boolean isAvailable(int fingerprint, String uri, String local, int arity)(Code)
Test whether a function with a given name and arity is available. This supports the function-available() function in XSLT. This method may be called either at compile time or at run time.
Parameters:
  uri - The URI of the function name
Parameters:
  local - The local part of the function name
Parameters:
  arity - The number of arguments. This is set to -1 in the case of the single-argumentfunction-available() function; in this case the method should return true if there is somematching extension function, regardless of its arity.



setConfiguration
public void setConfiguration(Configuration config)(Code)
Set the Configuration options



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.