org.apache.xerces.dom3.ls
Interface DocumentLS


public interface DocumentLS

The DocumentLS interface provides a mechanism by which the content of a document can be replaced with the DOM tree produced when loading a URI, or parsing a string. The expectation is that an instance of the DocumentLS interface can be obtained by using binding-specific casting methods on an instance of the Document interface.

uses the default features.

See also the Document Object Model (DOM) Level 3 Abstract Schemas and Load and Save Specification.


Method Summary
 void abort()
          If the document is currently being loaded as a result of the method load being invoked the loading and parsing is immediately aborted.
 boolean getAsync()
          Indicates whether the method load should be synchronous or asynchronous.
 boolean load(java.lang.String uri)
          Replaces the content of the document with the result of parsing the given URI.
 boolean loadXML(java.lang.String source)
          Replace the content of the document with the result of parsing the input string, this method is always synchronous.
 java.lang.String saveXML(org.w3c.dom.Node snode)
          Save the document or the given node to a string (i.e.
 void setAsync(boolean async)
          Indicates whether the method load should be synchronous or asynchronous.
 

Method Detail

getAsync

public boolean getAsync()
Indicates whether the method load should be synchronous or asynchronous. When the async attribute is set to true the load method returns control to the caller before the document has completed loading. The default value of this property is false.
Setting the value of this attribute might throw NOT_SUPPORTED_ERR if the implementation doesn't support the mode the attribute is being set to. Should the DOM spec define the default value of this property? What if implementing both async and sync IO is impractical in some systems? 2001-09-14. default is false but we need to check with Mozilla and IE.

setAsync

public void setAsync(boolean async)
Indicates whether the method load should be synchronous or asynchronous. When the async attribute is set to true the load method returns control to the caller before the document has completed loading. The default value of this property is false.
Setting the value of this attribute might throw NOT_SUPPORTED_ERR if the implementation doesn't support the mode the attribute is being set to. Should the DOM spec define the default value of this property? What if implementing both async and sync IO is impractical in some systems? 2001-09-14. default is false but we need to check with Mozilla and IE.

abort

public void abort()
If the document is currently being loaded as a result of the method load being invoked the loading and parsing is immediately aborted. The possibly partial result of parsing the document is discarded and the document is cleared.

load

public boolean load(java.lang.String uri)
Replaces the content of the document with the result of parsing the given URI. Invoking this method will either block the caller or return to the caller immediately depending on the value of the async attribute. Once the document is fully loaded the document will fire a "load" event that the caller can register as a listener for. If an error occurs the document will fire an "error" event so that the caller knows that the load failed (see ParseErrorEvent).
Parameters:
uri - The URI reference for the XML file to be loaded. If this is a relative URI...
Returns:
If async is set to true load returns true if the document load was successfully initiated. If an error occurred when initiating the document load load returns false.If async is set to false load returns true if the document was successfully loaded and parsed. If an error occurred when either loading or parsing the URI load returns false.

loadXML

public boolean loadXML(java.lang.String source)
Replace the content of the document with the result of parsing the input string, this method is always synchronous.
Parameters:
source - A string containing an XML document.
Returns:
true if parsing the input string succeeded without errors, otherwise false.

saveXML

public java.lang.String saveXML(org.w3c.dom.Node snode)
                         throws org.w3c.dom.DOMException
Save the document or the given node to a string (i.e. serialize the document or node).
Parameters:
snode - Specifies what to serialize, if this parameter is null the whole document is serialized, if it's non-null the given node is serialized.
Returns:
The serialized document or null.
Throws:
org.w3c.dom.DOMException - WRONG_DOCUMENT_ERR: Raised if the node passed in as the node parameter is from an other document.


Copyright © 1999-2002 Apache XML Project. All Rights Reserved.