Java Doc for GeneralVariable.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.expr.ComputedExpression
      net.sf.saxon.instruct.Instruction
         net.sf.saxon.instruct.GeneralVariable

All known Subclasses:   net.sf.saxon.instruct.Assign,  net.sf.saxon.instruct.GlobalVariable,  net.sf.saxon.instruct.LocalParam,  net.sf.saxon.instruct.LocalVariable,  net.sf.saxon.instruct.WithParam,
GeneralVariable
abstract public class GeneralVariable extends Instruction implements Binding(Code)
This class defines common behaviour across xsl:variable, xsl:param, and xsl:with-param; also saxon:assign


Field Summary
protected  intnameCode
    
protected  intreferenceCount
    
 SequenceTyperequiredType
    
 Expressionselect
    

Constructor Summary
public  GeneralVariable()
    

Method Summary
public  voiddisplay(int level, NamePool pool, PrintStream out)
     Diagnostic print of expression structure.
public  ItemevaluateItem(XPathContext context)
     Evaluate an expression as a single item.
public  intgetCardinality()
     Get the cardinality of the result of this instruction.
public  intgetInstructionNameCode()
    
public  ItemTypegetItemType(TypeHierarchy th)
     Get the type of the result of this instruction.
public  intgetLocalSlotNumber()
     If this is a local variable held on the local stack frame, return the corresponding slot number.
public  intgetNameCode()
    
public  SequenceTypegetRequiredType()
    
public  ExpressiongetSelectExpression()
    
public  ValueRepresentationgetSelectValue(XPathContext context)
     Evaluate the variable.
public  intgetSlotNumber()
    
public  intgetVariableFingerprint()
    
public  StringgetVariableName()
    
public  voidinit(Expression select, int nameCode)
    
final public  booleanisAssignable()
     Test whether it is permitted to assign to the variable using the saxon:assign extension element.
public  booleanisGlobal()
    
final public  booleanisRequiredParam()
    
final public  booleanisTunnelParam()
    
public  SequenceIteratoriterate(XPathContext context)
     Return an Iterator to iterate over the values of a sequence.
public  IteratoriterateSubExpressions()
    
public  Expressionoptimize(Optimizer opt, StaticContext env, ItemType contextItemType)
    
protected  voidpromoteInst(PromotionOffer offer)
     Handle promotion offers, that is, non-local tree rewrites.
public  voidsetAssignable(boolean assignable)
    
public  voidsetNameCode(int nameCode)
    
public  voidsetReferenceCount(int refCount)
    
public  voidsetRequiredParam(boolean requiredParam)
    
public  voidsetRequiredType(SequenceType required)
    
public  voidsetSelectExpression(Expression select)
    
public  voidsetSlotNumber(int s)
    
public  voidsetTunnel(boolean tunnel)
    
public  voidsetVariableName(String s)
    
public  Expressionsimplify(StaticContext env)
    
public  ExpressiontypeCheck(StaticContext env, ItemType contextItemType)
    

Field Detail
nameCode
protected int nameCode(Code)



referenceCount
protected int referenceCount(Code)



requiredType
SequenceType requiredType(Code)



select
Expression select(Code)




Constructor Detail
GeneralVariable
public GeneralVariable()(Code)




Method Detail
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:
  out -



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



getCardinality
public int getCardinality()(Code)
Get the cardinality of the result of this instruction. An xsl:variable instruction returns nothing, so the type is empty. the empty cardinality.



getInstructionNameCode
public int getInstructionNameCode()(Code)



getItemType
public ItemType getItemType(TypeHierarchy th)(Code)
Get the type of the result of this instruction. An xsl:variable instruction returns nothing, so the type is empty. the empty type.
Parameters:
  th -



getLocalSlotNumber
public int getLocalSlotNumber()(Code)
If this is a local variable held on the local stack frame, return the corresponding slot number. In other cases, return -1.



getNameCode
public int getNameCode()(Code)



getRequiredType
public SequenceType getRequiredType()(Code)



getSelectExpression
public Expression getSelectExpression()(Code)



getSelectValue
public ValueRepresentation getSelectValue(XPathContext context) throws XPathException(Code)
Evaluate the variable. That is, get the value of the select expression if present or the content of the element otherwise, either as a tree or as a sequence



getSlotNumber
public int getSlotNumber()(Code)



getVariableFingerprint
public int getVariableFingerprint()(Code)
Get the name of the variable (as a NamePool fingerprint) the NamePool fingerprint of the variable's expanded name.



getVariableName
public String getVariableName()(Code)



init
public void init(Expression select, int nameCode)(Code)



isAssignable
final public boolean isAssignable()(Code)
Test whether it is permitted to assign to the variable using the saxon:assign extension element. This will only be true if the extra attribute saxon:assignable="yes" is present.



isGlobal
public boolean isGlobal()(Code)



isRequiredParam
final public boolean isRequiredParam()(Code)



isTunnelParam
final public boolean isTunnelParam()(Code)



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 relies on the process() method: it "pushes" the results of the instruction to a sequence in memory, and then iterates over this in-memory sequence. In principle instructions should implement a pipelined iterate() method that avoids the overhead of intermediate storage.
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



iterateSubExpressions
public Iterator iterateSubExpressions()(Code)
Get all the XPath expressions associated with this instruction (in XSLT terms, the expression present on attributes of the instruction, as distinct from the child instructions in a sequence construction)



optimize
public Expression optimize(Optimizer opt, StaticContext env, ItemType contextItemType) throws XPathException(Code)



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 -



setAssignable
public void setAssignable(boolean assignable)(Code)



setNameCode
public void setNameCode(int nameCode)(Code)



setReferenceCount
public void setReferenceCount(int refCount)(Code)



setRequiredParam
public void setRequiredParam(boolean requiredParam)(Code)



setRequiredType
public void setRequiredType(SequenceType required)(Code)



setSelectExpression
public void setSelectExpression(Expression select)(Code)



setSlotNumber
public void setSlotNumber(int s)(Code)



setTunnel
public void setTunnel(boolean tunnel)(Code)



setVariableName
public void setVariableName(String s)(Code)



simplify
public Expression simplify(StaticContext env) throws XPathException(Code)



typeCheck
public Expression typeCheck(StaticContext env, ItemType contextItemType) throws XPathException(Code)



Methods inherited from net.sf.saxon.instruct.Instruction
public static void appendItem(Item it, SequenceReceiver out, int locationId) throws XPathException(Code)(Java Doc)
protected static ParameterSet assembleParams(XPathContext context, WithParam[] actualParams) throws XPathException(Code)(Java Doc)
protected static ParameterSet assembleTunnelParams(XPathContext context, WithParam[] actualParams) throws XPathException(Code)(Java Doc)
public int computeCardinality()(Code)(Java Doc)
public int computeSpecialProperties()(Code)(Java Doc)
public boolean createsNewNodes()(Code)(Java Doc)
protected static XPathException dynamicError(SourceLocator loc, XPathException error, XPathContext context)(Code)(Java Doc)
final public String evaluateAsString(XPathContext context) throws XPathException(Code)(Java Doc)
public Item evaluateItem(XPathContext context) throws XPathException(Code)(Java Doc)
public int getImplementationMethod()(Code)(Java Doc)
public InstructionInfo getInstructionInfo()(Code)(Java Doc)
public int getInstructionNameCode()(Code)(Java Doc)
public ItemType getItemType(TypeHierarchy th)(Code)(Java Doc)
public SourceLocator getSourceLocator()(Code)(Java Doc)
public boolean isXSLT(XPathContext context)(Code)(Java Doc)
public SequenceIterator iterate(XPathContext context) throws XPathException(Code)(Java Doc)
public void process(XPathContext context) throws XPathException(Code)(Java Doc)
abstract public TailCall processLeavingTail(XPathContext context) throws XPathException(Code)(Java Doc)
public Expression promote(PromotionOffer offer) throws XPathException(Code)(Java Doc)
protected void promoteInst(PromotionOffer offer) throws XPathException(Code)(Java Doc)
abstract public Expression simplify(StaticContext env) throws XPathException(Code)(Java Doc)

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.