Field Detail

• XMLINFO_DTD_PUBLIC_ID_FORTE

  @Deprecated
  public static final java.lang.String XMLINFO_DTD_PUBLIC_ID_FORTE

  Deprecated. replaced with Lookup
  Public ID of xmlinfo dtd.

  See Also:

  Constant Field Values

• XMLINFO_DTD_PUBLIC_ID

  @Deprecated
  public static final java.lang.String XMLINFO_DTD_PUBLIC_ID

  Deprecated. replaced with Lookup

  See Also:

  Constant Field Values

• MIME

  public static final java.lang.String MIME

  Mime type of XML documents.

  See Also:

  Constant Field Values

• STATUS_NOT

  public static final int STATUS_NOT

  PROP_DOCUMENT not parsed yet. Constant for getStatus method.

  See Also:

  Constant Field Values

• STATUS_OK

  public static final int STATUS_OK

  PROP_DOCUMENT parsed ok. Constant for getStatus method.

  See Also:

  Constant Field Values

• STATUS_WARNING

  public static final int STATUS_WARNING

  PROP_DOCUMENT parsed with warnings. Constant for getStatus method.

  See Also:

  Constant Field Values

• STATUS_ERROR

  public static final int STATUS_ERROR

  PROP_DOCUMENT parsed with errors. Constant for getStatus method.

  See Also:

  Constant Field Values

• PROP_DOCUMENT

  public static final java.lang.String PROP_DOCUMENT

  property name of DOM document property

  See Also:

  Constant Field Values

• PROP_INFO

  @Deprecated
  public static final java.lang.String PROP_INFO

  Deprecated. info is not supported anymore. Replaced with lookup.
  property name of info property

  See Also:

  Constant Field Values

Constructor Detail

• XMLDataObject

  public XMLDataObject​(org.openide.filesystems.FileObject fo,
                       MultiFileLoader loader)
                throws DataObjectExistsException

  Create new XMLDataObject. It is usually called by a loader. A user can get existing XMLDataObject by calling DataObject.find(FileObject f) instead.

  Parameters:

  fo - the primary file object, never null

  loader - loader of this data object, never null

  Throws:

  DataObjectExistsException

• XMLDataObject

  protected XMLDataObject​(org.openide.filesystems.FileObject fo,
                          MultiFileLoader loader,
                          boolean registerEditor)
                   throws DataObjectExistsException

  Constructs XMLDataObject without any registered cookies (for editor, open, etc.). Useful for subclasses.

  Parameters:

  fo - the primary file object, never null

  loader - loader of this data object, never null

  registerEditor - call with false to skip registrations of various editor related cookies

  Throws:

  DataObjectExistsException

  Since:

  7.10

Method Detail

• createNodeDelegate

  protected org.openide.nodes.Node createNodeDelegate​()

  If the Info associated with this data object (if any) provides a subclass of Node, then this object is created to represent the XML data object, otherwise DataNode is created.

  Overrides:

  createNodeDelegate in class MultiDataObject

  Returns:

  the node representation for this data object

  See Also:

  DataNode

• updateIconBase

  @Deprecated
  protected void updateIconBase​(java.lang.String res)

  Deprecated. it is better to listen on properties
  Called when the info file is parsed and the icon should change.

  Parameters:

  res - resource for the icon

• handleDelete

  protected void handleDelete​()
                       throws java.io.IOException

  Description copied from class: DataObject
  Delete this object (implemented by subclasses).

  Overrides:

  handleDelete in class MultiDataObject

  Throws:

  java.io.IOException - if an error occures

• getHelpCtx

  public org.openide.util.HelpCtx getHelpCtx​()

  Description copied from class: DataObject
  Get help context for this object.

  Overrides:

  getHelpCtx in class MultiDataObject

  Returns:

  the help context

• getCookie

  public <T extends org.openide.nodes.Node.Cookie> T getCookie​(java.lang.Class<T> cls)

  Cookies from assigned Environment are not placed into protected CookieSet and can be obtained only by invoking this method.

  Cookie order for Info environments are handled consistently with CookieSet i.e. FIFO.

  Overrides:

  getCookie in class MultiDataObject

  Parameters:

  cls - the class to look for

  Returns:

  a cookie (instanceof cls) that has been found in info or super.getCookie(cls).

• getLookup

  public org.openide.util.Lookup getLookup​()

  Description copied from class: DataObject
  Represents a context of the data object. This method is a more general replacement for DataObject.getCookie(java.lang.Class<T>) and should preferably be used instead of the old method. The default implementation inside a data object returns the getNodeDelegate().getLookup() - which is the most compatible behaviour with previous versions. However this code has significant potential to deadlocks. That is why the preferred advice is to override the method to:

   class MyDataObject extends MultiDataObject {
     public @Override Lookup getLookup() {
       return getCookieSet().getLookup();
     }
   }
   

  Warning: the DataObject.getCookie(java.lang.Class<T>) method and DataObject.getLookup() method are ment to be interchangable - e.g. if you override one of them be sure to override also the other and try as much as possible to keep the same content in each of them. The default implementation tries to do that as much as possible.

  Overrides:

  getLookup in class MultiDataObject

  Returns:

  lookup representing this data object and its content

• createEditorCookie

  @Deprecated
  protected org.openide.cookies.EditorCookie createEditorCookie​()

  Deprecated. CookieSet factory should be used by subclasses instead.
  Allows subclasses to provide their own editor cookie.

  Returns:

  an editor cookie to be used as a result of getCookie(EditorCookie.class)

• getDocument

  public final org.w3c.dom.Document getDocument​()
                                         throws java.io.IOException,
                                                org.xml.sax.SAXException

  Creates w3c's document for the xml file. Either returns cached reference or parses the file and creates new document.

  Returns:

  the parsed document

  Throws:

  org.xml.sax.SAXException - if there is a parsing error

  java.io.IOException - if there is an I/O error

• getStatus

  public final int getStatus​()

  Returns:

  one of STATUS_XXX constants representing PROP_DOCUMENT state.

• getInfo

  @Deprecated
  public final XMLDataObject.Info getInfo​()

  Deprecated. not used anymore

  Returns:

  null

• setInfo

  @Deprecated
  public final void setInfo​(XMLDataObject.Info ii)
                     throws java.io.IOException

  Deprecated. does not do anything useful

  Throws:

  java.io.IOException

• parse

  @Deprecated
  public static org.w3c.dom.Document parse​(java.net.URL url)
                                    throws java.io.IOException,
                                           org.xml.sax.SAXException

  Deprecated. Use XMLUtil instead setting null error handler and validation to false.
  Provides access to internal XML parser. This method takes URL. After successful finish the document tree is returned. Used non validating parser.

  Parameters:

  url - the url to read the file from

  Throws:

  java.io.IOException

  org.xml.sax.SAXException

• parse

  @Deprecated
  public static org.w3c.dom.Document parse​(java.net.URL url,
                                           boolean validate)
                                    throws java.io.IOException,
                                           org.xml.sax.SAXException

  Deprecated. Use XMLUtil instead setting null handler.
  Provides access to internal XML parser. This method takes URL. After successful finish the document tree is returned. Used non validating parser.

  Parameters:

  url - the url to read the file from

  validate - if true validating parser is used

  Throws:

  java.io.IOException

  org.xml.sax.SAXException

• parse

  @Deprecated
  public static org.w3c.dom.Document parse​(java.net.URL url,
                                           org.xml.sax.ErrorHandler eh)
                                    throws java.io.IOException,
                                           org.xml.sax.SAXException

  Deprecated. Use XMLUtil instead setting validation to false.
  Provides access to internal XML parser. This method takes URL. After successful finish the document tree is returned.

  Parameters:

  url - the url to read the file from

  eh - error handler to notify about exception

  Throws:

  java.io.IOException

  org.xml.sax.SAXException

• parse

  @Deprecated
  public static org.w3c.dom.Document parse​(java.net.URL url,
                                           org.xml.sax.ErrorHandler eh,
                                           boolean validate)
                                    throws java.io.IOException,
                                           org.xml.sax.SAXException

  Deprecated. Use XMLUtil instead.
  Factory a DocumentBuilder and let it create a org.w3c.dom.Document This method takes URL. After successful finish the document tree is returned. A parser producing the Document has set entity resolver to system entity resolver chain.

  Parameters:

  url - the url to read the file from

  eh - error handler to notify about exception

  validate - if true validating parser is used

  Returns:

  org.w3c.dom.Document

  Throws:

  org.xml.sax.SAXException - annotated if thrown due to configuration problem

  javax.xml.parsers.FactoryConfigurationError

  java.io.IOException

• createParser

  @Deprecated
  public static org.xml.sax.Parser createParser​()

  Deprecated. Use XMLUtil instead. It will create a SAX XMLReader that is SAX Parser replacement. You will have to replace DocumentHandler by ContentHandler besause XMLReader accepts just ContentHandler.

  Alternatively if not interested in new callbacks defined by SAX 2.0 you can wrap returned XMLReader into XMLReaderAdapter that implements Parser.

  Creates SAX parse that can be used to parse XML files.

  Returns:

  sax parser

• createParser

  @Deprecated
  public static org.xml.sax.Parser createParser​(boolean validate)

  Deprecated. Use XMLUtil.createXMLReader(boolean,boolean) instead setting ns to false. For more details see createParser
  Factory SAX parser that can be used to parse XML files. The factory is created according to javax.xml.parsers.SAXParserFactory property. The parser has set entity resolver to system entity resolver chain.

  Parameters:

  validate - if true validating parser is returned

  Returns:

  sax parser or null if no parser can be created

  Throws:

  javax.xml.parsers.FactoryConfigurationError

• createDocument

  @Deprecated
  public static org.w3c.dom.Document createDocument​()

  Deprecated. Replaced with XMLUtil It directly violates DOM's root element reference read-only status. If you can not move to XMLUtil for compatabilty reasons please replace with following workaround:

   String templ = "";
   InputSource in = new InputSource(new StringReader(templ));
   in.setSystemId("StringReader");  //workaround
   DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
   Document doc = builder.parse(in);
   

  Creates empty DOM Document using JAXP factoring.

  Returns:

  Document or null on problems with JAXP factoring

• write

  @Deprecated
  public static void write​(org.w3c.dom.Document doc,
                           java.io.Writer writer)
                    throws java.io.IOException

  Deprecated. Encoding used by Writer may be in direct conflict with encoding declared in document. Replaced with Util.
  Writes DOM Document to writer.

  Parameters:

  doc - DOM Document to be written

  writer - OutoutStreamWriter preffered otherwise encoding will be left for implementation specific autodection

  Throws:

  java.io.IOException

• write

  @Deprecated
  public static void write​(org.w3c.dom.Document doc,
                           java.io.OutputStream out,
                           java.lang.String enc)
                    throws java.io.IOException

  Deprecated. Moved to XMLUtil.
  Write Document into OutputStream using given encoding. It is a shortcut for writing configurations etc. It guarantee just that data will be written. Structure and indentation may change.

  Parameters:

  doc - DOM Document to be written

  out - data sink

  enc - - XML defined encoding name (i.e. IANA defined, one of UTF-8, UNICODE, ASCII).

  Throws:

  java.io.IOException

• createInputSource

  @Deprecated
  public static org.xml.sax.InputSource createInputSource​(java.net.URL url)
                                                   throws java.io.IOException

  Deprecated. Deprecated as it was a workaround method. Replace with new InputSource(url.toExternalForm()).
  Creates SAX InputSource for specified URL

  Throws:

  java.io.IOException

• registerCatalogEntry

  @Deprecated
  public static void registerCatalogEntry​(java.lang.String publicId,
                                          java.lang.String uri)

  Deprecated. Do not rely on global (non-modular) resolvers. Use EntityCatalog and XMLUtil instead.
  Registers the given public ID as corresponding to a particular URI, typically a local copy. This URI will be used in preference to ones provided as system IDs in XML entity declarations. This mechanism would most typically be used for Document Type Definitions (DTDs), where the public IDs are formally managed and versioned.

  Any created parser use global entity resolver and you can register its catalog entry.

  Parameters:

  publicId - The managed public ID being mapped

  uri - The URI of the preferred copy of that entity

• registerCatalogEntry

  @Deprecated
  public static void registerCatalogEntry​(java.lang.String publicId,
                                          java.lang.String resourceName,
                                          java.lang.ClassLoader loader)

  Deprecated. Do not rely on global (non-modular) resolvers. Use EntityCatalog and XMLUtil instead.
  Registers a given public ID as corresponding to a particular Java resource in a given class loader, typically distributed with a software package. This resource will be preferred over system IDs included in XML documents. This mechanism should most typically be used for Document Type Definitions (DTDs), where the public IDs are formally managed and versioned.

  If a mapping to a URI has been provided, that mapping takes precedence over this one.

  Any created parser use global entity resolver and you can register its catalog entry.

  Parameters:

  publicId - The managed public ID being mapped

  resourceName - The name of the Java resource

  loader - The class loader holding the resource, or null if it is a system resource.

• addEntityResolver

  @Deprecated
  public static boolean addEntityResolver​(org.xml.sax.EntityResolver resolver)

  Deprecated. EntityResolver is a parser user responsibility. Every time set a EntityResolver to an XML parser you use. The OpenIDE now defines a system EntityCatalog.
  Add a given entity resolver to the NetBeans resolver chain. The resolver chain is searched by private chaining resolver until some registered resolver succed.

  Every created parser use global entity resolver and then chain.

  Parameters:

  resolver - non null resolver to be added

  Returns:

  true if successfully added

• removeEntityResolver

  @Deprecated
  public static org.xml.sax.EntityResolver removeEntityResolver​(org.xml.sax.EntityResolver resolver)

  Deprecated. EntityResolver is a parser user responsibility.
  Remove a given entity resolver from the NetBeans resolver chain.

  Every created parser use global entity resolver and then chain.

  Parameters:

  resolver - non null resolver to be removed

  Returns:

  removed resolver instance or null if not present

• registerInfo

  @Deprecated
  public static void registerInfo​(java.lang.String publicId,
                                  XMLDataObject.Info info)

  Deprecated. Register an Environment via lookup, see some details.
  Registers new Info to particular XML document content type as recognized by DTD public id. The registration is valid until JVM termination.

  Parameters:

  publicId - used as key

  info - associated value or null to unregister

• getRegisteredInfo

  @Deprecated
  public static XMLDataObject.Info getRegisteredInfo​(java.lang.String publicId)

  Deprecated. Register via lookup
  Obtain registered Info for particular DTD public ID.

  Parameters:

  publicId - key which value is required

  Returns:

  Info clone that is used for given publicId or null