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


net.sf.saxon.expr.XPathContext

All known Subclasses:   net.sf.saxon.expr.EarlyEvaluationContext,  net.sf.saxon.expr.XPathContextMinor,
XPathContext
public interface XPathContext (Code)
This class represents a context in which an XPath expression is evaluated.




Method Summary
public  voidchangeOutputDestination(Properties props, Result result, boolean isFinal, int validation, SchemaType schemaType)
     Set a new output destination, supplying the output format details.
public  ValueRepresentationevaluateLocalVariable(int slotnumber)
    
public  XPathContextgetCaller()
     Get the calling XPathContext (the next one down the stack).
public  ComparatorgetCollation(String name)
    
public  ConfigurationgetConfiguration()
    
public  ItemgetContextItem()
    
public  intgetContextPosition()
    
public  ControllergetController()
     Get the Controller.
public  GroupIteratorgetCurrentGroupIterator()
     Get the current group iterator.
public  SequenceIteratorgetCurrentIterator()
     Get the current iterator.
public  ModegetCurrentMode()
     Get the current mode.
public  RegexIteratorgetCurrentRegexIterator()
     Get the current regex iterator.
public  TemplategetCurrentTemplate()
     Get the current template.
public  ComparatorgetDefaultCollation()
    
public  intgetLast()
    
public  ParameterSetgetLocalParameters()
    
public  NamePoolgetNamePool()
    
public  InstructionInfoProvidergetOrigin()
     Get information about the creating expression or other construct.
public  intgetOriginatingConstructType()
     Get the type of location from which this context was created.
public  SequenceReceivergetReceiver()
     Get the Receiver to which output is currently being written.
public  StackFramegetStackFrame()
     Get a reference to the local stack frame for variables.
public  ParameterSetgetTunnelParameters()
     Get the tunnel parameters that were passed to the current function or template.
public  XPathContextMajor.XSLTContextgetXSLTContext()
    
public  booleanisAtLast()
    
public  XPathContextMajornewCleanContext()
    
public  XPathContextMajornewContext()
     Construct a new context as a copy of another.
public  XPathContextMinornewMinorContext()
     Construct a new minor context.
public  voidsetCaller(XPathContext caller)
    
public  voidsetCurrentIterator(SequenceIterator iter)
     Set a new sequence iterator.
public  voidsetLocalVariable(int slotnumber, ValueRepresentation value)
    
public  voidsetOrigin(InstructionInfoProvider expr)
     Set the creating expression (for use in diagnostics).
public  voidsetOriginatingConstructType(int loc)
     Set the type of creating expression (for use in diagnostics).
public  voidsetReceiver(SequenceReceiver receiver)
    
public  voidsetTemporaryReceiver(SequenceReceiver out)
     Set the receiver to which output is to be written, marking it as a temporary (non-final) output destination.
public  booleanuseLocalParameter(int fingerprint, LocalParam binding, boolean isTunnel)
     Use local parameter.



Method Detail
changeOutputDestination
public void changeOutputDestination(Properties props, Result result, boolean isFinal, int validation, SchemaType schemaType) throws XPathException(Code)
Set a new output destination, supplying the output format details.
Note that it is the caller's responsibility to close the Writer after use.
exception:
  XPathException - if any dynamic error occurs; andspecifically, if an attempt is made to switch to a final outputdestination while writing a temporary tree or sequence
Parameters:
  props - properties defining the output format
Parameters:
  result - Details of the new output destination
Parameters:
  isFinal - true if the destination is a final result tree(either the principal output or a secondary result tree); false ifit is a temporary tree, xsl:attribute, etc.



evaluateLocalVariable
public ValueRepresentation evaluateLocalVariable(int slotnumber)(Code)
Get the value of a local variable, identified by its slot number



getCaller
public XPathContext getCaller()(Code)
Get the calling XPathContext (the next one down the stack). This will be null if unknown, or if the bottom of the stack has been reached.



getCollation
public Comparator getCollation(String name) throws XPathException(Code)
Get a named collation



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



getContextItem
public Item getContextItem()(Code)
Get the context item the context item, or null if the context item is undefined



getContextPosition
public int getContextPosition() throws DynamicError(Code)
Get the context position (the position of the context item) the context position (starting at one)
throws:
  DynamicError - if the context position is undefined



getController
public Controller getController()(Code)
Get the Controller. May return null when running outside XSLT or XQuery



getCurrentGroupIterator
public GroupIterator getCurrentGroupIterator()(Code)
Get the current group iterator. This supports the current-group() and current-grouping-key() functions in XSLT 2.0 the current grouped collection



getCurrentIterator
public SequenceIterator getCurrentIterator()(Code)
Get the current iterator. This encapsulates the context item, context position, and context size. the current iterator, or null if there is no current iterator(which means the context item, position, and size are undefined).



getCurrentMode
public Mode getCurrentMode()(Code)
Get the current mode. the current mode



getCurrentRegexIterator
public RegexIterator getCurrentRegexIterator()(Code)
Get the current regex iterator. This supports the functionality of the regex-group() function in XSLT 2.0. the current regular expressions iterator



getCurrentTemplate
public Template getCurrentTemplate()(Code)
Get the current template. This is used to support xsl:apply-imports the current template



getDefaultCollation
public Comparator getDefaultCollation()(Code)
Get the default collation



getLast
public int getLast() throws XPathException(Code)
Get the context size (the position of the last item in the current node list) the context size
throws:
  XPathException - if the context position is undefined



getLocalParameters
public ParameterSet getLocalParameters()(Code)
Get the local (non-tunnel) parameters that were passed to the current function or template a ParameterSet containing the local parameters



getNamePool
public NamePool getNamePool()(Code)
Get the Name Pool



getOrigin
public InstructionInfoProvider getOrigin()(Code)
Get information about the creating expression or other construct.



getOriginatingConstructType
public int getOriginatingConstructType()(Code)
Get the type of location from which this context was created.



getReceiver
public SequenceReceiver getReceiver()(Code)
Get the Receiver to which output is currently being written. the current Receiver



getStackFrame
public StackFrame getStackFrame()(Code)
Get a reference to the local stack frame for variables. Note that it's the caller's job to make a local copy of this. This is used for creating a Closure containing a retained copy of the variables for delayed evaluation. array of variables.



getTunnelParameters
public ParameterSet getTunnelParameters()(Code)
Get the tunnel parameters that were passed to the current function or template. This includes all active tunnel parameters whether the current template uses them or not. a ParameterSet containing the tunnel parameters



getXSLTContext
public XPathContextMajor.XSLTContext getXSLTContext()(Code)
Get the XSLT-specific part of the context



isAtLast
public boolean isAtLast() throws XPathException(Code)
Determine whether the context position is the same as the context size that is, whether position()=last()



newCleanContext
public XPathContextMajor newCleanContext()(Code)
Construct a new context without copying (used for the context in a function call)



newContext
public XPathContextMajor newContext()(Code)
Construct a new context as a copy of another. The new context is effectively added to the top of a stack, and contains a pointer to the previous context



newMinorContext
public XPathContextMinor newMinorContext()(Code)
Construct a new minor context. A minor context can only hold new values of the focus (currentIterator) and current output destination.



setCaller
public void setCaller(XPathContext caller)(Code)
Set the calling XPathContext



setCurrentIterator
public void setCurrentIterator(SequenceIterator iter)(Code)
Set a new sequence iterator.



setLocalVariable
public void setLocalVariable(int slotnumber, ValueRepresentation value)(Code)
Set the value of a local variable, identified by its slot number



setOrigin
public void setOrigin(InstructionInfoProvider expr)(Code)
Set the creating expression (for use in diagnostics). The origin is generally set to "this" by the object that creates the new context. It's up to the debugger to determine whether this information is useful. Where possible, the object will be an InstructionInfoProvider , allowing information about the calling instruction to be obtained.



setOriginatingConstructType
public void setOriginatingConstructType(int loc)(Code)
Set the type of creating expression (for use in diagnostics). When a new context is created, either this method or XPathContext.setOrigin should be called.
Parameters:
  loc - The originating location: the argument must be one of the integer constants in classnet.sf.saxon.trace.Location



setReceiver
public void setReceiver(SequenceReceiver receiver)(Code)
Change the Receiver to which output is written



setTemporaryReceiver
public void setTemporaryReceiver(SequenceReceiver out)(Code)
Set the receiver to which output is to be written, marking it as a temporary (non-final) output destination.
Parameters:
  out - The SequenceOutputter to be used



useLocalParameter
public boolean useLocalParameter(int fingerprint, LocalParam binding, boolean isTunnel) throws XPathException(Code)
Use local parameter. This is called when a local xsl:param element is processed. If a parameter of the relevant name was supplied, it is bound to the xsl:param element. Otherwise the method returns false, so the xsl:param default will be evaluated
Parameters:
  fingerprint - The fingerprint of the parameter name
Parameters:
  binding - The XSLParam element to bind its value to
Parameters:
  isTunnel - True if a tunnel parameter is required, else false true if a parameter of this name was supplied, false if not



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.