org.netbeans.modules.xml.catalog.spi

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.catalog.spi 
org.netbeans.modules.xml.catalog.spi

XML Entity Catalog SPI

Maintainer: Petr Kuzel

Updated on: 31st June 2001

SPI Overview

The SPI is very simple, there is only one mandatory interface to be implemented. Then the implementation must be integrated with IDE.

SPI Implementator Guide

Every SPI implementation must implement interface {@link org.netbeans.modules.xml.catalog.spi.CatalogReader CatalogReader} allowing quering catalog for entries, refreshing its content and optionaly listening on its content.

An SPI implementation should implement following interfaces:

  • {@link org.netbeans.modules.xml.catalog.spi.CatalogDescriptor CatalogDescriptor} describing catalog instance
  • {@link org.netbeans.modules.xml.catalog.spi.CatalogWriter CatalogWriter} allowing to modify catalog entries
  • SAX's org.xml.sax.EntityResolver if it can resolve more complicated cases than public => system ID mappings

NetBeans IDE Platform Integration

An SPI implementation can register its availability using NetBeans Lookup. A module providing a new SPI implementation registers its avaiability using {@link org.netbeans.modules.xml.catalog.spi.CatalogProvider CatalogProvider} instance (declared at its XML Layer):
  <folder name="Services">
    <folder name="Hidden">
      <file name="my-company-netbeans-catalog-impl-MyProvider.instance" />
    </filder>
  </folder>
Where my.company.netbeans.catalog.impl.MyProvider public no-arg constructor class implements the CatalogProvider interface.

Using CatalogProvider just provides a kind of factory, so that the user can add one or more instances of the catalog at will. You may instead register a CatalogReader instance directly in your layer in the folder Plugins/XML/UserCatalogs/; such catalogs will be preinstalled and not deletable.

Forte for Java 3.0 Specifics Feature

If a catalog implements Serializable interface then its mounting point is persistent among IDE restarts. In such case it is highly recommended to explicitly declare serialVersionUID field.
Java Source File NameTypeComment
CatalogDescriptor.javaInterface It provides information about a catalog instance.
CatalogListener.javaInterface A callback interface notifying catalog content changes.
CatalogListenerAdapter.javaClass Do nothing implementation of CatalogListener.
CatalogProvider.javaInterface The interface is intended for NetBeans IDE platform integration.
CatalogReader.javaInterface An interface to catalog content reader.
CatalogWriter.javaInterface An interface that should be implemented by catalogs allowing modifications.
ProvidersRegistry.javaClass A utility class representing the registry of SPI implementations.
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.