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


java.lang.Object
   net.sf.saxon.expr.ComputedExpression
      net.sf.saxon.instruct.Instruction

All known Subclasses:   net.sf.saxon.instruct.Doctype,  net.sf.saxon.instruct.ApplyImports,  net.sf.saxon.instruct.SimpleNodeConstructor,  net.sf.saxon.instruct.ParentNodeConstructor,  net.sf.saxon.instruct.While,  net.sf.saxon.instruct.Block,  net.sf.saxon.instruct.CallTemplate,  net.sf.saxon.instruct.Choose,  net.sf.saxon.instruct.GeneralVariable,  net.sf.saxon.instruct.ApplyTemplates,  net.sf.saxon.instruct.CopyOf,  net.sf.saxon.instruct.ForEach,  net.sf.saxon.instruct.ResultDocument,  net.sf.saxon.instruct.TraceWrapper,  net.sf.saxon.instruct.Message,  net.sf.saxon.instruct.ForEachGroup,  net.sf.saxon.instruct.UseAttributeSets,  net.sf.saxon.instruct.AnalyzeString,
Instruction
abstract public class Instruction extends ComputedExpression implements SourceLocator,TailCallReturner(Code)
Abstract superclass for all instructions in the compiled stylesheet. This represents a compiled instruction, and as such, the minimum information is retained from the original stylesheet.
Note: this class implements SourceLocator: that is, it can identify where in the stylesheet the source instruction was located.



Constructor Summary
public  Instruction()
    

Method Summary
public static  voidappendItem(Item it, SequenceReceiver out, int locationId)
     Static method to append an item that results from evaluating an expression to the current result receiver.
protected static  ParameterSetassembleParams(XPathContext context, WithParam[] actualParams)
     Assemble a ParameterSet.
protected static  ParameterSetassembleTunnelParams(XPathContext context, WithParam[] actualParams)
     Assemble a ParameterSet.
public  intcomputeCardinality()
    
public  intcomputeSpecialProperties()
     Get the static properties of this expression (other than its type).
public  booleancreatesNewNodes()
     Determine whether this instruction creates new nodes.
protected static  XPathExceptiondynamicError(SourceLocator loc, XPathException error, XPathContext context)
     Construct an exception with diagnostic information.
final public  StringevaluateAsString(XPathContext context)
     Evaluate an expression as a String.
public  ItemevaluateItem(XPathContext context)
     Evaluate an expression as a single item.
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 prefered.
public  InstructionInfogetInstructionInfo()
    
public  intgetInstructionNameCode()
    
public  ItemTypegetItemType(TypeHierarchy th)
    
public  SourceLocatorgetSourceLocator()
    
public  booleanisXSLT(XPathContext context)
    
public  SequenceIteratoriterate(XPathContext context)
     Return an Iterator to iterate over the values of a sequence.
public  voidprocess(XPathContext context)
    
abstract public  TailCallprocessLeavingTail(XPathContext context)
     ProcessLeavingTail: called to do the real work of this instruction.
public  Expressionpromote(PromotionOffer offer)
     Offer promotion for this subexpression.
protected  voidpromoteInst(PromotionOffer offer)
     Handle promotion offers, that is, non-local tree rewrites.
abstract public  Expressionsimplify(StaticContext env)
     Simplify an expression.


Constructor Detail
Instruction
public Instruction()(Code)
Constructor




Method Detail
appendItem
public static void appendItem(Item it, SequenceReceiver out, int locationId) throws XPathException(Code)
Static method to append an item that results from evaluating an expression to the current result receiver. The method checks to see whether the item returned from the expression is actually a function-call-package representing the result of a tail call optimization; if so, the tail function calls are complete and the final result is passed on.
Parameters:
  it - the item: possibly a FunctionCallPackage
Parameters:
  out - the Receiver
throws:
  XPathException -



assembleParams
protected static ParameterSet assembleParams(XPathContext context, WithParam[] actualParams) throws XPathException(Code)
Assemble a ParameterSet. Method used by instructions that have xsl:with-param children. This method is used for the non-tunnel parameters.



assembleTunnelParams
protected static ParameterSet assembleTunnelParams(XPathContext context, WithParam[] actualParams) throws XPathException(Code)
Assemble a ParameterSet. Method used by instructions that have xsl:with-param children. This method is used for the tunnel parameters.



computeCardinality
public int computeCardinality()(Code)
Get the cardinality of the sequence returned by evaluating this instruction the static cardinality



computeSpecialProperties
public int computeSpecialProperties()(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



createsNewNodes
public boolean createsNewNodes()(Code)
Determine whether this instruction creates new nodes. This implementation returns a default value of false



dynamicError
protected static XPathException dynamicError(SourceLocator loc, XPathException error, XPathContext context)(Code)
Construct an exception with diagnostic information. Note that this method returns the exception, it does not throw it: that is up to the caller.
Parameters:
  error - The exception containing information about the error
Parameters:
  context - The controller of the transformation an exception based on the supplied exception, but with location informationadded relating to this instruction



evaluateAsString
final 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.
exception:
  net.sf.saxon.trans.XPathException - if any dynamic error occurs evaluating theexpression
exception:
  java.lang.ClassCastException - if the result type of theexpression is not xs:string?
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 "".



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
exception:
  XPathException - if any dynamic error occurs evaluating theexpression the node or atomic value that results from evaluating theexpression; or null to indicate that the result is an emptysequence



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 prefered. For instructions this is the process() method.



getInstructionInfo
public InstructionInfo getInstructionInfo()(Code)



getInstructionNameCode
public int getInstructionNameCode()(Code)
Get the namecode of the instruction for use in diagnostics



getItemType
public ItemType getItemType(TypeHierarchy th)(Code)
Get the item type of the items returned by evaluating this instruction the static item type of the instruction
Parameters:
  th -



getSourceLocator
public SourceLocator getSourceLocator()(Code)
Get a SourceLocator identifying the location of this instruction



isXSLT
public boolean isXSLT(XPathContext context)(Code)
Establish whether this is an XSLT instruction or an XQuery instruction (used to produce appropriate diagnostics)
Parameters:
  context - true for XSLT, false for XQuery



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.
exception:
  XPathException - if any dynamic error occurs evaluating theexpression
Parameters:
  context - supplies the context for evaluation a SequenceIterator that can be used to iterate over the resultof the expression



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.



processLeavingTail
abstract public TailCall processLeavingTail(XPathContext context) throws XPathException(Code)
ProcessLeavingTail: called to do the real work of this instruction. This method must be implemented in each subclass. The results of the instruction are written to the current Receiver, which can be obtained via the Controller.
Parameters:
  context - The dynamic context of the transformation, giving access to the current node,the current variables, etc. null if the instruction has completed execution; or a TailCall indicatinga function call or template call that is delegated to the caller, to be made after the stack hasbeen unwound so as to save stack space.



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. 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
exception:
  net.sf.saxon.trans.XPathException - if any error is detected if the offer is not accepted, return this expression unchanged.Otherwise return the result of rewriting the expression to promotethis subexpression



promoteInst
protected void promoteInst(PromotionOffer offer) throws XPathException(Code)
Handle promotion offers, that is, non-local tree rewrites.
Parameters:
  offer - The type of rewrite being offered
throws:
  XPathException -



simplify
abstract 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.
exception:
  net.sf.saxon.trans.XPathException - if an error is discovered during expressionrewriting the simplified expression



Fields inherited from net.sf.saxon.expr.ComputedExpression
protected int locationId(Code)(Java Doc)
protected int staticProperties(Code)(Java Doc)

Methods inherited from net.sf.saxon.expr.ComputedExpression
public void adoptChildExpression(Expression child)(Code)(Java Doc)
public void checkPermittedContents(SchemaType parentType, StaticContext env, boolean whole) throws XPathException(Code)(Java Doc)
abstract protected int computeCardinality()(Code)(Java Doc)
public int computeDependencies()(Code)(Java Doc)
public int computeSpecialProperties()(Code)(Java Doc)
final public void computeStaticProperties()(Code)(Java Doc)
final public Expression doPromotion(Expression subexpression, PromotionOffer offer) throws XPathException(Code)(Java Doc)
protected void dynamicError(String message, XPathContext context) throws DynamicError(Code)(Java Doc)
protected void dynamicError(String message, String code, XPathContext context) throws DynamicError(Code)(Java Doc)
public boolean effectiveBooleanValue(XPathContext context) throws XPathException(Code)(Java Doc)
public String evaluateAsString(XPathContext context) throws XPathException(Code)(Java Doc)
public Item evaluateItem(XPathContext context) throws XPathException(Code)(Java Doc)
public int getCardinality()(Code)(Java Doc)
public int getColumnNumber()(Code)(Java Doc)
protected int getConstructType()(Code)(Java Doc)
public int getDependencies()(Code)(Java Doc)
public Executable getExecutable()(Code)(Java Doc)
public int getImplementationMethod()(Code)(Java Doc)
public InstructionInfo getInstructionInfo()(Code)(Java Doc)
public int getIntrinsicDependencies()(Code)(Java Doc)
public int getLineNumber()(Code)(Java Doc)
final public int getLocationId()(Code)(Java Doc)
public LocationProvider getLocationProvider()(Code)(Java Doc)
public Container getParentExpression()(Code)(Java Doc)
final public String getPublicId()(Code)(Java Doc)
public int[] getSlotsUsed()(Code)(Java Doc)
final public int getSpecialProperties()(Code)(Java Doc)
public String getSystemId()(Code)(Java Doc)
public boolean hasBadParentPointer()(Code)(Java Doc)
public SequenceIterator iterate(XPathContext context) throws XPathException(Code)(Java Doc)
public Iterator iterateSubExpressions()(Code)(Java Doc)
public boolean markTailFunctionCalls()(Code)(Java Doc)
public void process(XPathContext context) throws XPathException(Code)(Java Doc)
public Expression promote(PromotionOffer offer) throws XPathException(Code)(Java Doc)
final public void resetStaticProperties()(Code)(Java Doc)
public void setLocationId(int id)(Code)(Java Doc)
public void setParentExpression(Container parent)(Code)(Java Doc)
public Expression simplify(StaticContext env) throws XPathException(Code)(Java Doc)
public void suppressValidation(int validationMode)(Code)(Java Doc)
protected void typeError(String message, XPathContext context) throws DynamicError(Code)(Java Doc)
protected void typeError(String message, String errorCode, XPathContext context) throws DynamicError(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.