Java Doc for GrammarQuery.java in  » IDE-Netbeans » xml » org » netbeans » modules » xml » api » model » 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 » IDE Netbeans » xml » org.netbeans.modules.xml.api.model 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.netbeans.modules.xml.api.model.GrammarQuery

All known Subclasses:   org.netbeans.modules.xml.xsd.XSDGrammarResolver,  org.netbeans.modules.xml.text.completion.EmptyQuery,  org.netbeans.modules.xsl.grammar.XSLGrammarQuery,  org.netbeans.modules.xml.xsd.XSDGrammar,
GrammarQuery
public interface GrammarQuery (Code)
A query interface returning possible fenomens as given by document grammar.

It provides at specified HintContext following information:

  • allowed element names and namespaces
  • allowed entity names
  • allowed notation names
  • allowed attribute names
  • allowed values of attribute values or element content
This information are returned as Enumeration. Every member of the enumeration represents one possible option. Empty enumeration signals that no hint can be derived from grammar in given context.

Every option represents DOM Node that can have children. These children represents mandatory content for given option. Providing them is optional. On the other hand EMPTY elements may not provide any children.

Context Representation

Query context is represented by a read-only DOM1 model Core and XML modules (it may be replaced with DOM2).

Implementation Note:

DOM1 does describe only non-DTD part of document.

Passed context may represent errorous XML document. The code must take into account that it can get nulls even on places where it does not expect it. E.g. getParentNode() as the DOM document can be constructed as a best effort one.

Also as the context may originate from a text editor it is better to rely on getPreviousSibling rather then getNextSibling as user usaully types text from document begining.
author:
   Petr Kuzel





Method Summary
 java.awt.ComponentgetCustomizer(HintContext nodeCtx)
    
 org.openide.nodes.Node.Property[]getProperties(HintContext nodeCtx)
    
 booleanhasCustomizer(HintContext nodeCtx)
    
 booleanisAllowed(Enumeration<GrammarResult> en)
     Distinquieshes between empty enumaration types.
 Enumeration<GrammarResult>queryAttributes(HintContext ownerElementCtx)
     Query attribute options for given context.
 GrammarResultqueryDefault(HintContext parentNodeCtx)
     query default value for given context.
 Enumeration<GrammarResult>queryElements(HintContext virtualElementCtx)
    
Parameters:
  virtualElementCtx - represents virtual element Node that has to be replaced, its own attributes does not name sense, it can be used just as the navigation start point.
 Enumeration<GrammarResult>queryEntities(String prefix)
     Allow to get names of parsed general entities.
 Enumeration<GrammarResult>queryNotations(String prefix)
     Allow to get names of declared notations.
 Enumeration<GrammarResult>queryValues(HintContext virtualTextCtx)
     Return options for value at given context. It could be also used for completing of value parts such as Ant or XSLT property names (how to trigger it?).
Parameters:
  virtualTextCtx - represents virtual Node that has to be replaced (parent can be either Attr or Element), its own attributes does not name sense, it can be used just as the navigation start point.



Method Detail
getCustomizer
java.awt.Component getCustomizer(HintContext nodeCtx)(Code)
Allows Grammars to supply customizer for the HintContext
Parameters:
  ctx - the hint context node a Component which can be used to customize the context node



getProperties
org.openide.nodes.Node.Property[] getProperties(HintContext nodeCtx)(Code)
Allows Grammars to supply properties for the HintContext
Parameters:
  ctx - the hint context node an array of properties for this context



hasCustomizer
boolean hasCustomizer(HintContext nodeCtx)(Code)
Allows Grammars to supply customizer from the HintContext
Parameters:
  ctx - the hint context node true if a customizer is available for this context



isAllowed
boolean isAllowed(Enumeration<GrammarResult> en)(Code)
Distinquieshes between empty enumaration types. true there is no known result false grammar does not allow here a result



queryAttributes
Enumeration<GrammarResult> queryAttributes(HintContext ownerElementCtx)(Code)
Query attribute options for given context. All implementations must handle queries based on owner element context.
Parameters:
  ownerElementCtx - represents owner Element that will host result. enumeration of GrammarResults (ATTRIBUTE_NODEs) that can be queried on name, and attributes.Every list member represents one possibility.



queryDefault
GrammarResult queryDefault(HintContext parentNodeCtx)(Code)
query default value for given context. Two context types must be handled: an attribute and an element context.
Parameters:
  parentNodeCtx - context for which default is queried default value or null



queryElements
Enumeration<GrammarResult> queryElements(HintContext virtualElementCtx)(Code)

Parameters:
  virtualElementCtx - represents virtual element Node that has to be replaced, its own attributes does not name sense, it can be used just as the navigation start point. enumeration of GrammarResults (ELEMENT_NODEs) that can be queried on name, and attributes.Every list member represents one possibility.



queryEntities
Enumeration<GrammarResult> queryEntities(String prefix)(Code)
Allow to get names of parsed general entities.
Parameters:
  prefix - prefix filter enumeration of GrammarResults (ENTITY_REFERENCE_NODEs)



queryNotations
Enumeration<GrammarResult> queryNotations(String prefix)(Code)
Allow to get names of declared notations.
Parameters:
  prefix - prefix filter enumeration of GrammarResults (NOTATION_NODEs)



queryValues
Enumeration<GrammarResult> queryValues(HintContext virtualTextCtx)(Code)
Return options for value at given context. It could be also used for completing of value parts such as Ant or XSLT property names (how to trigger it?).
Parameters:
  virtualTextCtx - represents virtual Node that has to be replaced (parent can be either Attr or Element), its own attributes does not name sense, it can be used just as the navigation start point. enumeration of GrammarResults (TEXT_NODEs) that can be queried on name, and attributes.Every list member represents one possibility.



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