All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.w3c.dom.ls.LSInput Maven / Gradle / Ivy

Go to download

Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family. This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is the reference implementation of XNI but other parser components, configurations, and parsers can be written using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual. Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema 1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that it does not yet provide an option to enable normalization checking as described in section 2.13 of this specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.

The newest version!
/*
 * Copyright (c) 2004 World Wide Web Consortium,
 *
 * (Massachusetts Institute of Technology, European Research Consortium for
 * Informatics and Mathematics, Keio University). All Rights Reserved. This
 * work is distributed under the W3C(r) Software License [1] in the hope that
 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
 */

package org.w3c.dom.ls;

/**
 *  This interface represents an input source for data. 
 * 
 This interface allows an application to encapsulate information about 
 * an input source in a single object, which may include a public 
 * identifier, a system identifier, a byte stream (possibly with a specified 
 * encoding), a base URI, and/or a character stream. 
 * 
 The exact definitions of a byte stream and a character stream are 
 * binding dependent. 
 * 
 The application is expected to provide objects that implement this 
 * interface whenever such objects are needed. The application can either 
 * provide its own objects that implement this interface, or it can use the 
 * generic factory method DOMImplementationLS.createLSInput() 
 * to create objects that implement this interface. 
 * 
 The LSParser will use the LSInput object to 
 * determine how to read data. The LSParser will look at the 
 * different inputs specified in the LSInput in the following 
 * order to know which one to read from, the first one that is not null and 
 * not an empty string will be used: 
 * 
    
 * 
  1.  LSInput.characterStream 
 * 
    2. 
 * 
  2.  
 * LSInput.byteStream 
 * 
    3. 
 * 
  3.  LSInput.stringData 
 * 
    4. 
 * 
  4.  
 * LSInput.systemId 
 * 
    5. 
 * 
  5.  LSInput.publicId 
 * 
    6. 
 * 
 
 * 
 If all inputs are null, the LSParser will report a 
 * DOMError with its DOMError.type set to 
 * "no-input-specified" and its DOMError.severity 
 * set to DOMError.SEVERITY_FATAL_ERROR. 
 * 
 LSInput objects belong to the application. The DOM 
 * implementation will never modify them (though it may make copies and 
 * modify the copies, if necessary). 
 * 
See also the Document Object Model (DOM) Level 3 Load
and Save Specification.
 */
public interface LSInput {
    /**
     *  An attribute of a language and binding dependent type that represents 
     * a stream of 16-bit units. The application must encode the stream 
     * using UTF-16 (defined in [Unicode] and in [ISO/IEC 10646]). It is not a requirement to have an XML declaration when 
     * using character streams. If an XML declaration is present, the value 
     * of the encoding attribute will be ignored. 
     */
    public java.io.Reader getCharacterStream();
    /**
     *  An attribute of a language and binding dependent type that represents 
     * a stream of 16-bit units. The application must encode the stream 
     * using UTF-16 (defined in [Unicode] and in [ISO/IEC 10646]). It is not a requirement to have an XML declaration when 
     * using character streams. If an XML declaration is present, the value 
     * of the encoding attribute will be ignored. 
     */
    public void setCharacterStream(java.io.Reader characterStream);

    /**
     *  An attribute of a language and binding dependent type that represents 
     * a stream of bytes. 
     * 
 If the application knows the character encoding of the byte 
     * stream, it should set the encoding attribute. Setting the encoding in 
     * this way will override any encoding specified in an XML declaration 
     * in the data. 
     */
    public java.io.InputStream getByteStream();
    /**
     *  An attribute of a language and binding dependent type that represents 
     * a stream of bytes. 
     * 
 If the application knows the character encoding of the byte 
     * stream, it should set the encoding attribute. Setting the encoding in 
     * this way will override any encoding specified in an XML declaration 
     * in the data. 
     */
    public void setByteStream(java.io.InputStream byteStream);

    /**
     *  String data to parse. If provided, this will always be treated as a 
     * sequence of 16-bit units (UTF-16 encoded characters). It is not a 
     * requirement to have an XML declaration when using 
     * stringData. If an XML declaration is present, the value 
     * of the encoding attribute will be ignored. 
     */
    public String getStringData();
    /**
     *  String data to parse. If provided, this will always be treated as a 
     * sequence of 16-bit units (UTF-16 encoded characters). It is not a 
     * requirement to have an XML declaration when using 
     * stringData. If an XML declaration is present, the value 
     * of the encoding attribute will be ignored. 
     */
    public void setStringData(String stringData);

    /**
     *  The system identifier, a URI reference [IETF RFC 2396], for this 
     * input source. The system identifier is optional if there is a byte 
     * stream, a character stream, or string data. It is still useful to 
     * provide one, since the application will use it to resolve any 
     * relative URIs and can include it in error messages and warnings. (The 
     * LSParser will only attempt to fetch the resource identified by the 
     * URI reference if there is no other input available in the input 
     * source.) 
     * 
 If the application knows the character encoding of the object 
     * pointed to by the system identifier, it can set the encoding using 
     * the encoding attribute. 
     * 
 If the specified system ID is a relative URI reference (see 
     * section 5 in [IETF RFC 2396]), the DOM 
     * implementation will attempt to resolve the relative URI with the 
     * baseURI as the base, if that fails, the behavior is 
     * implementation dependent. 
     */
    public String getSystemId();
    /**
     *  The system identifier, a URI reference [IETF RFC 2396], for this 
     * input source. The system identifier is optional if there is a byte 
     * stream, a character stream, or string data. It is still useful to 
     * provide one, since the application will use it to resolve any 
     * relative URIs and can include it in error messages and warnings. (The 
     * LSParser will only attempt to fetch the resource identified by the 
     * URI reference if there is no other input available in the input 
     * source.) 
     * 
 If the application knows the character encoding of the object 
     * pointed to by the system identifier, it can set the encoding using 
     * the encoding attribute. 
     * 
 If the specified system ID is a relative URI reference (see 
     * section 5 in [IETF RFC 2396]), the DOM 
     * implementation will attempt to resolve the relative URI with the 
     * baseURI as the base, if that fails, the behavior is 
     * implementation dependent. 
     */
    public void setSystemId(String systemId);

    /**
     *  The public identifier for this input source. This may be mapped to an 
     * input source using an implementation dependent mechanism (such as 
     * catalogues or other mappings). The public identifier, if specified, 
     * may also be reported as part of the location information when errors 
     * are reported. 
     */
    public String getPublicId();
    /**
     *  The public identifier for this input source. This may be mapped to an 
     * input source using an implementation dependent mechanism (such as 
     * catalogues or other mappings). The public identifier, if specified, 
     * may also be reported as part of the location information when errors 
     * are reported. 
     */
    public void setPublicId(String publicId);

    /**
     *  The base URI to be used (see section 5.1.4 in [IETF RFC 2396]) for 
     * resolving a relative systemId to an absolute URI. 
     * 
 If, when used, the base URI is itself a relative URI, an empty 
     * string, or null, the behavior is implementation dependent. 
     */
    public String getBaseURI();
    /**
     *  The base URI to be used (see section 5.1.4 in [IETF RFC 2396]) for 
     * resolving a relative systemId to an absolute URI. 
     * 
 If, when used, the base URI is itself a relative URI, an empty 
     * string, or null, the behavior is implementation dependent. 
     */
    public void setBaseURI(String baseURI);

    /**
     *  The character encoding, if known. The encoding must be a string 
     * acceptable for an XML encoding declaration ([XML 1.0] section 
     * 4.3.3 "Character Encoding in Entities"). 
     * 
 This attribute has no effect when the application provides a 
     * character stream or string data. For other sources of input, an 
     * encoding specified by means of this attribute will override any 
     * encoding specified in the XML declaration or the Text declaration, or 
     * an encoding obtained from a higher level protocol, such as HTTP [IETF RFC 2616]. 
     */
    public String getEncoding();
    /**
     *  The character encoding, if known. The encoding must be a string 
     * acceptable for an XML encoding declaration ([XML 1.0] section 
     * 4.3.3 "Character Encoding in Entities"). 
     * 
 This attribute has no effect when the application provides a 
     * character stream or string data. For other sources of input, an 
     * encoding specified by means of this attribute will override any 
     * encoding specified in the XML declaration or the Text declaration, or 
     * an encoding obtained from a higher level protocol, such as HTTP [IETF RFC 2616]. 
     */
    public void setEncoding(String encoding);

    /**
     *  If set to true, assume that the input is certified (see section 2.13 
     * in [XML 1.1]) when 
     * parsing [XML 1.1]. 
     */
    public boolean getCertifiedText();
    /**
     *  If set to true, assume that the input is certified (see section 2.13 
     * in [XML 1.1]) when 
     * parsing [XML 1.1]. 
     */
    public void setCertifiedText(boolean certifiedText);

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy