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


java.lang.Object
   net.sf.saxon.pattern.PatternSponsor

PatternSponsor
public class PatternSponsor implements Expression(Code)
The PatternSponsor class allows a Pattern to be treated like an expression. Although patterns are not evaluated at run-time in the same way as expressions, they need to be manipulated in much the same way as expressions at compile time: for example variables need to be bound, dependencies need to be analyzed, and so on. This is especially true of patterns appearing in the xsl:number and xsl:for-each-group instructions (less so for the more common match patterns in xsl:template).

This class implements the Expression interface, so that an Expression can have a PatternSponsor as a subexpression; it wraps a Pattern.

A Pattern is treated as a boolean expression that returns true if the pattern matches the context node. However, it is not currently evaluated in that way.




Constructor Summary
public  PatternSponsor(Pattern pattern)
    

Method Summary
public  voidcheckPermittedContents(SchemaType parentType, StaticContext env, boolean whole)
     Check statically that the results of the expression are capable of constructing the content of a given schema type.
public  voiddisplay(int level, NamePool pool, PrintStream out)
     Diagnostic print of expression structure.
public  booleaneffectiveBooleanValue(XPathContext context)
     Get the effective boolean value of the expression.
public  StringevaluateAsString(XPathContext context)
     Evaluate an expression as a String.
public  ItemevaluateItem(XPathContext context)
     Evaluate an expression as a single item.
public  intgetCardinality()
    

Determine the static cardinality of the expression.

public  intgetDependencies()
     Determine which aspects of the context the expression depends on.
public  intgetImplementationMethod()
     An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process(). This method indicates which of these methods is provided directly.
public  ItemTypegetItemType(TypeHierarchy th)
     Determine the data type of the expression, if possible.
public  ContainergetParentExpression()
     Get the container that immediately contains this expression.
public  PatterngetPattern()
    
public  intgetSpecialProperties()
     Get the static properties of this expression (other than its type).
public  SequenceIteratoriterate(XPathContext context)
     Return an Iterator to iterate over the values of a sequence.
public  IteratoriterateSubExpressions()
     Get the immediate sub-expressions of this expression.
public  Expressionoptimize(Optimizer opt, StaticContext env, ItemType contextItemType)
     Perform optimisation of an expression and its subexpressions.

This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.


Parameters:
  opt - the optimizer in use.
public  voidprocess(XPathContext context)
    
public  Expressionpromote(PromotionOffer offer)
     Offer promotion for this subexpression.
public  Expressionsimplify(StaticContext env)
     Simplify an expression.
public  ExpressiontypeCheck(StaticContext env, ItemType contextItemType)
     Perform type checking of an expression and its subexpressions.

This checks statically that the operands of the expression have the correct type; if necessary it generates code to do run-time type checking or type conversion.



Constructor Detail
PatternSponsor
public PatternSponsor(Pattern pattern)(Code)




Method Detail
checkPermittedContents
public void checkPermittedContents(SchemaType parentType, StaticContext env, boolean whole) throws XPathException(Code)
Check statically that the results of the expression are capable of constructing the content of a given schema type.
Parameters:
  parentType - The schema type
Parameters:
  env - the static context
Parameters:
  whole - true if this expression is expected to make the whole content of the type, falseif it is expected to make up only a part
throws:
  net.sf.saxon.trans.XPathException - if the expression doesn't match the required content type



display
public void display(int level, NamePool pool, PrintStream out)(Code)
Diagnostic print of expression structure. The expression is written to the System.err output stream
Parameters:
  level - indentation level for this expression
Parameters:
  pool - NamePool used to expand any names appearing in the expression
Parameters:
  out - Output destination



effectiveBooleanValue
public boolean effectiveBooleanValue(XPathContext context) throws XPathException(Code)
Get the effective boolean value of the expression. This returns false if the value is the empty sequence, a zero-length string, a number equal to zero, or the boolean false. Otherwise it returns true.
Parameters:
  context - The context in which the expression is to be evaluated the effective boolean value
throws:
  net.sf.saxon.trans.XPathException - if any dynamic error occurs evaluating theexpression



evaluateAsString
public String evaluateAsString(XPathContext context) throws XPathException(Code)
Evaluate an expression as a String. This function must only be called in contexts where it is known that the expression will return a single string (or where an empty sequence is to be treated as a zero-length string). Implementations should not attempt to convert the result to a string, other than converting () to "". This method is used mainly to evaluate expressions produced by compiling an attribute value template.
Parameters:
  context - The context in which the expression is to be evaluated the value of the expression, evaluated in the current context.The expression must return a string or (); if the value of theexpression is (), this method returns "".
throws:
  net.sf.saxon.trans.XPathException - if any dynamic error occurs evaluating theexpression
throws:
  ClassCastException - if the result type of theexpression is not xs:string?



evaluateItem
public Item evaluateItem(XPathContext context) throws XPathException(Code)
Evaluate an expression as a single item. This always returns either a single Item or null (denoting the empty sequence). No conversion is done. This method should not be used unless the static type of the expression is a subtype of "item" or "item?": that is, it should not be called if the expression may return a sequence. There is no guarantee that this condition will be detected.
Parameters:
  context - The context in which the expression is to be evaluated the node or atomic value that results from evaluating theexpression; or null to indicate that the result is an emptysequence
throws:
  net.sf.saxon.trans.XPathException - if any dynamic error occurs evaluating theexpression



getCardinality
public int getCardinality()(Code)

Determine the static cardinality of the expression. This establishes how many items there will be in the result of the expression, at compile time (i.e., without actually evaluating the result.

This method should always return a result, though it may be the best approximation that is available at the time.

one of the values StaticProperty.ALLOWS_ONE,StaticProperty.ALLOWS_ZERO_OR_MORE, StaticProperty.ALLOWS_ZERO_OR_ONE,StaticProperty.ALLOWS_ONE_OR_MORE, StaticProperty.EMPTY.



getDependencies
public int getDependencies()(Code)
Determine which aspects of the context the expression depends on. The result is a bitwise-or'ed value composed from constants such as net.sf.saxon.expr.StaticProperty.DEPENDS_ON_CONTEXT_ITEM and net.sf.saxon.expr.StaticProperty.DEPENDS_ON_CURRENT_ITEM . The default implementation combines the intrinsic dependencies of this expression with the dependencies of the subexpressions, computed recursively. This is overridden for expressions such as FilterExpression where a subexpression's dependencies are not necessarily inherited by the parent expression. a set of bit-significant flags identifying the dependencies ofthe expression



getImplementationMethod
public int getImplementationMethod()(Code)
An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process(). This method indicates which of these methods is provided directly. The other methods will always be available indirectly, using an implementation that relies on one of the other methods.



getItemType
public ItemType getItemType(TypeHierarchy th)(Code)
Determine the data type of the expression, if possible. All expression return sequences, in general; this method determines the type of the items within the sequence, assuming that (a) this is known in advance, and (b) it is the same for all items in the sequence.

This method should always return a result, though it may be the best approximation that is available at the time.

a value such as Type.STRING, Type.BOOLEAN, Type.NUMBER,Type.NODE, or Type.ITEM (meaning not known at compile time)
Parameters:
  th -



getParentExpression
public Container getParentExpression()(Code)
Get the container that immediately contains this expression. This method returns null for an outermost expression; it also return null in the case of literal values. For an XPath expression occurring within an XSLT stylesheet, this method returns the XSLT instruction containing the XPath expression. the expression that contains this expression, if known; return nullif there is no containing expression or if the containing expression is unknown.



getPattern
public Pattern getPattern()(Code)
Get the wrapped pattern



getSpecialProperties
public int getSpecialProperties()(Code)
Get the static properties of this expression (other than its type). The result is bit-signficant. These properties are used for optimizations. In general, if property bit is set, it is true, but if it is unset, the value is unknown. a set of flags indicating static properties of this expression



iterate
public SequenceIterator iterate(XPathContext context) throws XPathException(Code)
Return an Iterator to iterate over the values of a sequence. The value of every expression can be regarded as a sequence, so this method is supported for all expressions. This default implementation handles iteration for expressions that return singleton values: for non-singleton expressions, the subclass must provide its own implementation.
Parameters:
  context - supplies the context for evaluation a SequenceIterator that can be used to iterate over the resultof the expression
throws:
  net.sf.saxon.trans.XPathException - if any dynamic error occurs evaluating theexpression



iterateSubExpressions
public Iterator iterateSubExpressions()(Code)
Get the immediate sub-expressions of this expression. Default implementation returns a zero-length array, appropriate for an expression that has no sub-expressions. an iterator containing the sub-expressions of this expression



optimize
public Expression optimize(Optimizer opt, StaticContext env, ItemType contextItemType) throws XPathException(Code)
Perform optimisation of an expression and its subexpressions.

This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.


Parameters:
  opt - the optimizer in use. This provides access to supporting functions; it also allowsdifferent optimization strategies to be used in different circumstances.
Parameters:
  env - the static context of the expression
Parameters:
  contextItemType - the static type of "." at the point where this expression is invoked.The parameter is set to null if it is known statically that the context item will be undefined.If the type of the context item is not known statically, the argument is set tonet.sf.saxon.type.Type.ITEM_TYPE the original expression, rewritten if appropriate to optimize execution
throws:
  net.sf.saxon.trans.StaticError - if an error is discovered during this phase(typically a type error)



process
public void process(XPathContext context) throws XPathException(Code)
Process the instruction, without returning any tail calls
Parameters:
  context - The dynamic context, giving access to the current node,the current variables, etc.



promote
public Expression promote(PromotionOffer offer) throws XPathException(Code)
Offer promotion for this subexpression. The offer will be accepted if the subexpression is not dependent on the factors (e.g. the context item) identified in the PromotionOffer. By default the offer is not accepted - this is appropriate in the case of simple expressions such as constant values and variable references where promotion would give no performance advantage. This method is always called at compile time.
Parameters:
  offer - details of the offer, for example the offer to moveexpressions that don't depend on the context to an outer level inthe containing expression if the offer is not accepted, return this expression unchanged.Otherwise return the result of rewriting the expression to promotethis subexpression
throws:
  net.sf.saxon.trans.XPathException - if any error is detected



simplify
public Expression simplify(StaticContext env) throws XPathException(Code)
Simplify an expression. This performs any static optimization (by rewriting the expression as a different expression). The default implementation does nothing. the simplified expression
throws:
  net.sf.saxon.trans.StaticError - if an error is discovered during expressionrewriting



typeCheck
public Expression typeCheck(StaticContext env, ItemType contextItemType) throws XPathException(Code)
Perform type checking of an expression and its subexpressions.

This checks statically that the operands of the expression have the correct type; if necessary it generates code to do run-time type checking or type conversion. A static type error is reported only if execution cannot possibly succeed, that is, if a run-time type error is inevitable. The call may return a modified form of the expression.

This method is called after all references to functions and variables have been resolved to the declaration of the function or variable. However, the types of such functions and variables may not be accurately known if they have not been explicitly declared.


Parameters:
  env - the static context of the expression
Parameters:
  contextItemType - the static type of "." at the point where this expression is invoked.The parameter is set to null if it is known statically that the context item will be undefined.If the type of the context item is not known statically, the argument is set tonet.sf.saxon.type.Type.ITEM_TYPE the original expression, rewritten to perform necessaryrun-time type checks, and to perform other type-relatedoptimizations
throws:
  net.sf.saxon.trans.StaticError - if an error is discovered during this phase(typically a type error)



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.