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


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

All known Subclasses:   net.sf.saxon.pattern.AnyNodeTest,  net.sf.saxon.pattern.SubstitutionGroupTest,  net.sf.saxon.pattern.CombinedNodeTest,  net.sf.saxon.pattern.AnyChildNodePattern,  net.sf.saxon.pattern.DocumentNodeTest,  net.sf.saxon.pattern.NameTest,  net.sf.saxon.pattern.NamespaceTest,  net.sf.saxon.pattern.NodeKindTest,  net.sf.saxon.pattern.NoNodeTest,  net.sf.saxon.pattern.LocalNameTest,  net.sf.saxon.pattern.ContentTypeTest,
NodeTest
abstract public class NodeTest implements ItemType,Serializable(Code)
A NodeTest is a simple kind of pattern that enables a context-free test of whether a node has a particular name. There are several kinds of node test: a full name test, a prefix test, and an "any node of a given type" test, an "any node of any type" test, a "no nodes" test (used, e.g. for "@comment()").

As well as being used to support XSLT pattern matching, NodeTests act as predicates in axis steps, and also act as item types for type matching.


author:
   Michael H. Kay




Method Summary
public  AtomicTypegetAtomizedItemType()
    
public  SchemaTypegetContentType()
     Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes). Return AnyType if there are no restrictions.
abstract public  doublegetDefaultPriority()
    
public  intgetFingerprint()
     Get the name of the nodes matched by this nodetest, if it matches a specific name.
abstract public  intgetNodeKindMask()
     Get a mask indicating which kinds of nodes this NodeTest can match.
public  ItemTypegetPrimitiveItemType()
     Get the primitive item type corresponding to this item type.
public  intgetPrimitiveType()
     Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node, or Type.Node if it matches different kinds of nodes.
public  IntHashSetgetRequiredNodeNames()
     Get the set of node names allowed by this NodeTest.
public  ItemTypegetSuperType(TypeHierarchy th)
     Get the type from which this item type is derived by restriction.
public  booleanisAtomicType()
    
abstract public  booleanmatches(TinyTree tree, int nodeNr)
     Test whether this node test is satisfied by a given node on a TinyTree.
abstract public  booleanmatches(int nodeKind, int fingerprint, int annotation)
     Test whether this node test is satisfied by a given node.
abstract public  booleanmatches(NodeInfo node)
     Test whether this node test is satisfied by a given node.
public  booleanmatchesItem(Item item, XPathContext context)
     Test whether a given item conforms to this type.
public  StringtoString(NamePool pool)
    



Method Detail
getAtomizedItemType
public AtomicType getAtomizedItemType()(Code)
Get the item type of the atomic values that will be produced when an item of this type is atomized (assuming that atomization succeeds)



getContentType
public SchemaType getContentType()(Code)
Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes). Return AnyType if there are no restrictions. The default implementation returns AnyType.



getDefaultPriority
abstract public double getDefaultPriority()(Code)
Determine the default priority of this node test when used on its own as a Pattern



getFingerprint
public int getFingerprint()(Code)
Get the name of the nodes matched by this nodetest, if it matches a specific name. Return -1 if the node test matches nodes of more than one name



getNodeKindMask
abstract public int getNodeKindMask()(Code)
Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination of bits: 1<



getPrimitiveItemType
public ItemType getPrimitiveItemType()(Code)
Get the primitive item type corresponding to this item type. For item(), this is Type.ITEM. For node(), it is Type.NODE. For specific node kinds, it is the value representing the node kind, for example Type.ELEMENT. For anyAtomicValue it is Type.ATOMIC_VALUE. For numeric it is Type.NUMBER. For other atomic types it is the primitive type as defined in XML Schema, except that INTEGER is considered to be a primitive type.



getPrimitiveType
public int getPrimitiveType()(Code)
Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node, or Type.Node if it matches different kinds of nodes. the node kind matched by this node test



getRequiredNodeNames
public IntHashSet getRequiredNodeNames()(Code)
Get the set of node names allowed by this NodeTest. This is returned as a set of Integer fingerprints. A null value indicates that all names are permitted (i.e. that there are no constraints on the node name. The default implementation returns null.



getSuperType
public ItemType getSuperType(TypeHierarchy th)(Code)
Get the type from which this item type is derived by restriction. This is the supertype in the XPath type heirarchy, as distinct from the Schema base type: this means that the supertype of xs:boolean is xdt:anyAtomicType, whose supertype is item() (rather than xs:anySimpleType).

In fact the concept of "supertype" is not really well-defined, because the types form a lattice rather than a hierarchy. The only real requirement on this function is that it returns a type that strictly subsumes this type, ideally as narrowly as possible. the supertype, or null if this type is item()
Parameters:
  th -




isAtomicType
public boolean isAtomicType()(Code)
Determine whether this item type is atomic (that is, whether it can ONLY match atomic values) false: this is not ANY_ATOMIC_TYPE or a subtype thereof



matches
abstract public boolean matches(TinyTree tree, int nodeNr)(Code)
Test whether this node test is satisfied by a given node on a TinyTree. The node must be a document, element, text, comment, or processing instruction node. This method is provided so that when navigating a TinyTree a node can be rejected without actually instantiating a NodeInfo object.
Parameters:
  tree - the TinyTree containing the node
Parameters:
  nodeNr - the number of the node within the TinyTree true if the node matches the NodeTest, otherwise false



matches
abstract public boolean matches(int nodeKind, int fingerprint, int annotation)(Code)
Test whether this node test is satisfied by a given node. This method is only fully supported for a subset of NodeTests, because it doesn't provide all the information needed to evaluate all node tests. In particular (a) it can't be used to evaluate a node test of the form element(N,T) or schema-element(E) where it is necessary to know whether the node is nilled, and (b) it can't be used to evaluate a node test of the form document-node(element(X)). This in practice means that it is used (a) to evaluate the simple node tests found in the XPath 1.0 subset used in XML Schema, and (b) to evaluate node tests where the node kind is known to be an attribute.
Parameters:
  nodeKind - The kind of node to be matched
Parameters:
  fingerprint - identifies the expanded name of the node to be matched.The value should be -1 for a node with no name.
Parameters:
  annotation - The actual content type of the node



matches
abstract public boolean matches(NodeInfo node)(Code)
Test whether this node test is satisfied by a given node. This alternative method is used in the case of nodes where calculating the fingerprint is expensive, for example DOM or JDOM nodes.
Parameters:
  node - the node to be matched



matchesItem
public boolean matchesItem(Item item, XPathContext context)(Code)
Test whether a given item conforms to this type. This implements a method of the ItemType interface.
Parameters:
  item - The item to be tested
Parameters:
  context - true if the item is an instance of this type; false otherwise



toString
public String toString(NamePool pool)(Code)
Display the type descriptor for diagnostics



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.