General Information

Question (arch-what): What is this project good for?
Answer: It helps with editing XML files and supports leveraging XML in developed application.
Question (arch-overall): Describe the overall architecture.
Answer:

XML APIs provide support for editing XML files and leveraging XML in developed application. XMLAPIs

Question (arch-usecases): Describe the main use cases of the new API. Who will use it under what circumstances? What kind of code would typically need to be written to use the module?
WARNING: Question with id="arch-usecases" has not been answered!
Question (arch-time): What are the time estimates of the work?
WARNING: Question with id="arch-time" has not been answered!
Question (arch-quality): How will the quality of your code be tested and how are future regressions going to be prevented?
WARNING: Question with id="arch-quality" has not been answered!
Question (arch-where): Where one can find sources for your module?
WARNING: Question with id="arch-where" has not been answered!

Project and platform dependencies

Question (dep-nb): What other NetBeans projects and modules does this one depend on?
Answer: It uses various kinds of API's:
• NodesAPI The support class NodeAction.
• WindowSystemAPI NodeAction uses TopComponent.Registry.
• Explorer -

  PasteAction uses ExplorerManager.

• Filesystems -

  E.g. FileSystemAction uses FileSystem.

• Datasystems -

  E.g. FileSystemAction uses DataObject.

• UtilitiesAPI

The default answer to this question is:


These modules are required in project.xml:

• org.openide.loaders - The module is needed for compilation. The module is used during runtime.
• org.openide.filesystems - The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
• org.openide.util - The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
• org.openide.nodes - The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
• org.openide.text - The module is needed for compilation. The module is used during runtime. Specification version 6.16 is required.
Question (dep-non-nb): What other projects outside NetBeans does this one depend on?
Answer: W3C's SAC API and Flute - it's implementation.
Question (dep-platform): On which platforms does your module run? Does it run in the same way on each?
Answer: 100% pure Java.
Question (dep-jre): Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
Answer: It requires JRE 1.3.
Question (dep-jrejdk): Do you require the JDK or is the JRE enough?
Answer: JRE is enough.

Deployment

Question (deploy-jar): Do you deploy just module JAR file(s) or other files as well?
Answer: It comes with several files in exttt> area. Namely flute.jar, sac.jar, resolver_nb.jar and xerces2.jar. SAC and Flute should be moved to libs. Resolver and Xerces should be replaced by existing libs sub projects.
Question (deploy-nbm): Can you deploy an NBM via the Update Center?
Answer: Yes.
Question (deploy-shared): Do you need to be installed in the shared location only, or in the user directory only, or can your module be installed anywhere?
Answer: It does not matter.
Question (deploy-packages): Are packages of your module made inaccessible by not declaring them public?
Answer: XML tools APIs are exported. Also several experimental packages is exposed. Openide-Module-Provides and Openide-Module-Requires guarding tokens are defined for these.
Question (deploy-dependencies): What do other modules need to do to declare a dependency on this one, in addition to or instead of the normal module dependency declaration (e.g. tokens to require)?
WARNING: Question with id="deploy-dependencies" has not been answered!

Compatibility with environment

Question (compat-i18n): Is your module correctly internationalized?
Answer: All but code generated by JavaCC.
Question (compat-standards): Does the module implement or define any standards? Is the implementation exact or does it deviate somehow?
Answer: The support implements following standards XML 1.0 Recommendation, XML Schema Recommendation, XSLT Recommendation, CSS Level 2 Recommendation, DOM Level 1 Core and XML Recommendation, SAX version 2, JAXP 1.1 Specification and XML Catalog Standard.
Question (compat-version): Can your module coexist with earlier and future versions of itself? Can you correctly read all old settings? Will future versions be able to read your current settings? Can you read or politely ignore settings stored by a future version?
Answer: It uses several persistence mechanisms including Java serialization of third party objects. It's not fully under module control.
Question (compat-deprecation): How the introduction of your project influences functionality provided by previous version of the product?
WARNING: Question with id="compat-deprecation" has not been answered!

Access to resources

Question (resources-file): Does your module use java.io.File directly?
Answer: Yes to access files that are referenced by file: protocol.
Question (resources-layer): Does your module provide own layer? Does it create any files or folders in it? What it is trying to communicate by that and with which components?
Answer: Yes. Almost all registrations are placed on it.
Question (resources-read): Does your module read any resources from layers? For what purpose?
Answer: Grammar and scenario providers registrations. Probably more to come and start to use layer as a naming service. Can also register global XML catalogs as instances of CatalogReader in Plugins/XML/UserCatalogs.
Question (resources-mask): Does your module mask/hide/override any resources provided by other modules in their layers?
Answer: Branded version of module masks its own parts.
Question (resources-preferences): Does your module uses preferences via Preferences API? Does your module use NbPreferences or or regular JDK Preferences ? Does it read, write or both ? Does it share preferences with other modules ? If so, then why ?
WARNING: Question with id="resources-preferences" has not been answered!

Lookup of components

Question (lookup-lookup): Does your module use org.openide.util.Lookup or any similar technology to find any components to communicate with? Which ones?
Answer: Almost all XMLDataObject properties all in turn searched in default Lookup.
Question (lookup-register): Do you register anything into lookup for other code to find?
Answer: XML submodules registers in lookup their action and cookies. Also text grammars and user's catalogs are registered in lookup.
Question (lookup-remove): Do you remove entries of other modules from lookup?
Answer: No.

Execution Environment

Question (exec-property): Is execution of your code influenced by any environment or Java system (System.getProperty) property? On a similar note, is there something interesting that you pass to java.util.logging.Logger? Or do you observe what others log?
Answer: XML modules uses following system properties:

netbeans.xml.completion={fast|default|accurate}
netbeans.experimental.xml.nodeselectors={true|false}
netbeans.debug.exceptions={true|false}
netbeans.debug.editor.draw={true|false}
netbeans.debug.xml={true|false}
netbeans.xml.reportBogusSchemaLocation={true|false}
org.netbeans.tax{packages}={true|false}

Question (exec-component): Is execution of your code influenced by any (string) property of any of your components?
Answer: A lot of defined by Open APIs.
Question (exec-ant-tasks): Do you define or register any ant tasks that other can use?
WARNING: Question with id="exec-ant-tasks" has not been answered!
Question (exec-classloader): Does your code create its own class loader(s)?
Answer: Yes, xerces2.jar is loaded by an isolatings classloader. There is strong implementation dependency and the module can use two Xerces versions.
Question (exec-reflection): Does your code use Java Reflection to execute other code?
Answer: Yes to access EntityCatalog's map that is filled by deprecated registration methods. In TAX to construct instance of isolated Xerces parser. In TokenContext for fill a map from instance fields. In BeanUtil to introspect beans. In AbstractObjectNode to introspect listeners using a debug action. In ElementInfo and WriteCache to apply declaratively defined property values. In org.netbeans.modules.xml.tree.nodes.propertysheet which is tuned copy of OpenAPI's propertysheet API. In TreeEventChangeSupport to get access to listeners list. In TreeStreamResult and XNIBuilder to access/set internal DTD as plain string. It could be replaced by a map.
Question (exec-privateaccess): Are you aware of any other parts of the system calling some of your methods by reflection?
Answer: No.
Question (exec-process): Do you execute an external process from your module? How do you ensure that the result is the same on different platforms? Do you parse output? Do you depend on result code?
WARNING: Question with id="exec-process" has not been answered!
Question (exec-introspection): Does your module use any kind of runtime type information (instanceof, work with java.lang.Class, etc.)?
WARNING: Question with id="exec-introspection" has not been answered!
Question (exec-threading): What threading models, if any, does your module adhere to? How the project behaves with respect to threading?
WARNING: Question with id="exec-threading" has not been answered!
Question (security-policy): Does your functionality require modifications to the standard policy file?
WARNING: Question with id="security-policy" has not been answered!
Question (security-grant): Does your code grant additional rights to some other code?
WARNING: Question with id="security-grant" has not been answered!

Format of files and protocols

Question (format-types): Which protocols and file formats (if any) does your module read or write on disk, or transmit or receive over the network? Do you generate an ant build script? Can it be edited and modified?
Answer: Configuration XMLs. Users XMLs and CCS files.
Question (format-dnd): Which protocols (if any) does your code understand during Drag & Drop?
Answer: See format-clibpoard.
Question (format-clipboard): Which data flavors (if any) does your code read from or insert to the clipboard (by access to clipboard on means calling methods on java.awt.datatransfer.Transferable?
Answer: Implementations of cut, copy and paste (CutAction, CopyAction and PasteAction) reads/writes from/into clipboard. It uses standard java datatransfer mechanism and Netbeans extension to the mechanism.

Performance and Scalability

Question (perf-startup): Does your module run any code on startup?
Answer: It registers some editor stuff.
Question (perf-exit): Does your module run any code on exit?
Answer: No.
Question (perf-scale): Which external criteria influence the performance of your program (size of file in editor, number of files in menu, in source directory, etc.) and how well your code scales?
Answer: It scales linearly to input. Transformations and validation depends on complexity of declarations.
Question (perf-limit): Are there any hard-coded or practical limits in the number or size of elements your code can handle?
Answer: Size of available memory is the limit. It depends on JVM configuration.
Question (perf-mem): How much memory does your component consume? Estimate with a relation to the number of windows, etc.
Answer: XML Document model takes 10-20 times memory comparing to plain text representation.
Question (perf-wakeup): Does any piece of your code wake up periodically and do something even when the system is otherwise idle (no user interaction)?
Answer: No.
Question (perf-progress): Does your module execute any long-running tasks?
Answer: XSLT transformations and XML validation tasks. User cannot cancel those and there is not any progress feedback.
Question (perf-huge_dialogs): Does your module contain any dialogs or wizards with a large number of GUI controls such as combo boxes, lists, trees, or text areas?
Answer: Several multi-step wizards with tables.
Question (perf-menus): Does your module use dynamically updated context menus, or context-sensitive actions with complicated and slow enablement logic?
Answer: It creates dynamically changing context menus. Enableness logic is under providers control. Known providers uses cookie checks that can needlessly initialize these.
Question (perf-spi): How the performance of the plugged in code will be enforced?
WARNING: Question with id="perf-spi" has not been answered!