org.w3c.dom.ls
인터페이스 LSInput

public interface LSInput

이 인터페이스는 데이터의 입력 소스를 나타냅니다.

이 인터페이스를 사용하면, 어플리케이션으로 입력 소스에 관한 정보를 단일의 객체에 캡슐화할 수 있습니다. 이 객체에는 공개 식별자, 시스템 식별자, 바이트 스트림 (인코딩이 가리키는 경우도 있다), 베이스 URI, 혹은 문자 스트림등이 포함됩니다.

바이트 스트림과 문자 스트림의 정확한 정의는 바인딩에 따라서 다릅니다.

어플리케이션은 전술과 같은 객체가 필요한 때는 언제라도, 이 인터페이스를 구현하는 객체를 가지는 것이 요구됩니다. 어플리케이션에서는 이 인터페이스를 구현하는 독자적인 객체를 갖추거나 일반의 팩토리 메서드의 DOMImplementationLS.createLSInput()를 사용하거나 해, 이 인터페이스를 구현하는 객체를 작성할 수 있습니다.

LSParser는 LSInput 객체를 사용해, 데이터를 읽어내는 방법을 결정합니다. LSParser는 LSInput로 지정된 다른 입력을 다음의 순서에 검색해, 읽어내는 입력을 인식합니다. 다음에 null은 아니고 한편 비어있는 캐릭터 라인이 아닌 최초의 입력을 사용합니다.

1. LSInput.characterStream
2. LSInput.byteStream
3. LSInput.stringData
4. LSInput.systemId
5. LSInput.publicId

입력이 모두 null인 경우, LSParser는 「no-input-specified」로 설정된 DOMError.type와 DOMError.SEVERITY_FATAL_ERROR 으로 설정된 그 DOMError.severity로 DOMError를 보고합니다.

어플리케이션에 소속하는 LSInput 객체. DOM 구현에서는 LSInput 객체를 변경할 것은 없습니다 (필요에 따라서, 복사본을 작성해 변경하는 것은 가능).

「Document Object Model (DOM) Level 3 Load and Save Specification」도 참조하십시오.

메서드 개요

String	getBaseURI () 상대 systemId를 절대 URI에 대해서 해결할 경우에 사용되는 베이스 URI 입니다 (「IETF RFC 2396」의 섹션 5.1. 4를 참조).
InputStream	getByteStream () 언어의 속성 및 바이트의 스트림을 나타내는 바인딩 존의 형태입니다.
boolean	getCertifiedText () true 로 설정하는 경우, 입력은 해석시 (「XML 1.1」)에 증명되는 것을 전제로 합니다 (「XML 1.1」의 섹션 2.13을 참조).
Reader	getCharacterStream () 언어의 속성 및 16 비트 단위의 스트림을 나타내는 바인딩 존의 형태입니다.
String	getEncoding () 기존의 경우는 문자 인코딩입니다.
String	getPublicId () 이 입력 소스의 공개 식별자입니다.
String	getStringData () 구문 분석 하는 캐릭터 라인 데이터입니다.
String	getSystemId () 이 입력 소스의 시스템 식별자, URI 참조「IETF RFC 2396」입니다.
void	setBaseURI (String baseURI) 상대 systemId를 절대 URI에 대해서 해결할 경우에 사용되는 베이스 URI 입니다 (「IETF RFC 2396」의 섹션 5.1. 4를 참조).
void	setByteStream (InputStream byteStream) 언어의 속성 및 바이트의 스트림을 나타내는 바인딩 존의 형태입니다.
void	setCertifiedText (boolean certifiedText) true 로 설정하는 경우, 입력은 해석시 (「XML 1.1」)에 증명되는 것을 전제로 합니다 (「XML 1.1」의 섹션 2.13을 참조).
void	setCharacterStream (Reader characterStream) 언어의 속성 및 16 비트 단위의 스트림을 나타내는 바인딩 존의 형태입니다.
void	setEncoding (String encoding) 기존의 경우는 문자 인코딩입니다.
void	setPublicId (String publicId) 이 입력 소스의 공개 식별자입니다.
void	setStringData (String stringData) 구문 분석 하는 캐릭터 라인 데이터입니다.
void	setSystemId (String systemId) 이 입력 소스의 시스템 식별자, URI 참조「IETF RFC 2396」입니다.

메서드의 상세

getCharacterStream

Reader  getCharacterStream()

언어의 속성 및 16 비트 단위의 스트림을 나타내는 바인딩 존의 형태입니다. 어플리케이션은 UTF-16 ( 「Unicode」, 「ISO/IEC 10646」으로 정의되고 있다)를 사용하는 스트림을 encode 할 필요가 있습니다. 문자 스트림을 사용하는 경우, XML 선언은 필요 없습니다. XML 선언이 존재하는 경우, 인코딩 속성의 값은 무시됩니다.

setCharacterStream

void setCharacterStream(Reader  characterStream)

언어의 속성 및 16 비트 단위의 스트림을 나타내는 바인딩 존의 형태입니다. 어플리케이션은 UTF-16 ( 「Unicode」, 「ISO/IEC 10646」으로 정의되고 있다)를 사용하는 스트림을 encode 할 필요가 있습니다. 문자 스트림을 사용하는 경우, XML 선언은 필요 없습니다. XML 선언이 존재하는 경우, 인코딩 속성의 값은 무시됩니다.

getByteStream

InputStream  getByteStream()

언어의 속성 및 바이트의 스트림을 나타내는 바인딩 존의 형태입니다.
어플리케이션이 바이트 스트림의 문자 인코딩을 인식하고 있는 경우, 어플리케이션에서는 인코딩 속성을 설정할 필요가 있습니다. 데이터의 XML 선언으로 가리키는 인코딩은 이 방법에 따르는 인코딩의 설정에 의해 오버라이드(override) 됩니다.

setByteStream

void setByteStream(InputStream  byteStream)

언어의 속성 및 바이트의 스트림을 나타내는 바인딩 존의 형태입니다.
어플리케이션이 바이트 스트림의 문자 인코딩을 인식하고 있는 경우, 어플리케이션에서는 인코딩 속성을 설정할 필요가 있습니다. 데이터의 XML 선언으로 가리키는 인코딩은 이 방법에 따르는 인코딩의 설정에 의해 오버라이드(override) 됩니다.

getStringData

String  getStringData()

구문 분석 하는 캐릭터 라인 데이터입니다. 제공되고 있는 경우는 항상 16 비트 단위의 순서 (UTF-16 로 encode 된 캐릭터 라인)로서 처리됩니다. stringData를 사용하는 경우, XML 선언은 필요 없습니다. XML 선언이 존재하는 경우, 인코딩 속성의 값은 무시됩니다.

setStringData

void setStringData(String  stringData)

구문 분석 하는 캐릭터 라인 데이터입니다. 제공되고 있는 경우는 항상 16 비트 단위의 순서 (UTF-16 로 encode 된 캐릭터 라인)로서 처리됩니다. stringData를 사용하는 경우, XML 선언은 필요 없습니다. XML 선언이 존재하는 경우, 인코딩 속성의 값은 무시됩니다.

getSystemId

String  getSystemId()

이 입력 소스의 시스템 식별자, URI 참조「IETF RFC 2396」입니다. 바이트 스트림, 문자 스트림, 혹은 캐릭터 라인 데이터가 있는 경우, 시스템 식별자는 옵션입니다만, 어플리케이션은 시스템 식별자를 사용해 상대 URI를 해결해, 에러 메세지나 경고에 포함할 수가 있으므로 시스템 식별자를 가지면 도움이 됩니다. LSParser는 입력 소스로 다른 입력을 이용할 수 없는 경우만, URI 참조에 의해 식별한 자원을 취득하려고 합니다.
어플리케이션이, 시스템 식별자로 포인트 된 객체의 문자 인코딩을 인식하고 있는 경우, 어플리케이션은 encoding 속성을 사용해 인코딩을 설정할 수 있습니다.
지정된 시스템 ID가 상대 URI 참조 (「IETF RFC 2396」의 섹션 5를 참조)인 경우, DOM 구현은 기반으로서 baseURI를 사용해 상대 URI를 해결하려고 합니다. 이것이 실패했을 경우, 동작은 구현 존입니다.

setSystemId

void setSystemId(String  systemId)

이 입력 소스의 시스템 식별자, URI 참조「IETF RFC 2396」입니다. 바이트 스트림, 문자 스트림, 혹은 캐릭터 라인 데이터가 있는 경우, 시스템 식별자는 옵션입니다만, 어플리케이션은 시스템 식별자를 사용해 상대 URI를 해결해, 에러 메세지나 경고에 포함할 수가 있으므로 시스템 식별자를 가지면 도움이 됩니다. LSParser는 입력 소스로 다른 입력을 이용할 수 없는 경우만, URI 참조에 의해 식별한 자원을 취득하려고 합니다.
어플리케이션이, 시스템 식별자로 포인트 된 객체의 문자 인코딩을 인식하고 있는 경우, 어플리케이션은 encoding 속성을 사용해 인코딩을 설정할 수 있습니다.
지정된 시스템 ID가 상대 URI 참조 (「IETF RFC 2396」의 섹션 5를 참조)인 경우, DOM 구현은 기반으로서 baseURI를 사용해 상대 URI를 해결하려고 합니다. 이것이 실패했을 경우, 동작은 구현 존입니다.

getPublicId

String  getPublicId()

이 입력 소스의 공개 식별자입니다. 이 식별자는 구현 존의 메카니즘 (카탈로그나 다른 매핑등)을 사용해 입력 소스에 맵 할 수 있습니다. 지정되었을 경우, 에러 보고시의 위치 정보의 일부로서 공개 식별자를 보고할 수도 있습니다.

setPublicId

void setPublicId(String  publicId)

이 입력 소스의 공개 식별자입니다. 이 식별자는 구현 존의 메카니즘 (카탈로그나 다른 매핑등)을 사용해 입력 소스에 맵 할 수 있습니다. 지정되었을 경우, 에러 보고시의 위치 정보의 일부로서 공개 식별자를 보고할 수도 있습니다.

getBaseURI

String  getBaseURI()

상대 systemId를 절대 URI에 대해서 해결할 경우에 사용되는 베이스 URI 입니다 (「IETF RFC 2396」의 섹션 5.1. 4를 참조).
사용했을 때에 베이스 URI가 상대 URI, 공백, 캐릭터 라인, 또는 null 인 경우, 동작은 구현 의존입니다.

setBaseURI

void setBaseURI(String  baseURI)

상대 systemId를 절대 URI에 대해서 해결할 경우에 사용되는 베이스 URI 입니다 (「IETF RFC 2396」의 섹션 5.1. 4를 참조).
사용했을 때에 베이스 URI가 상대 URI, 공백, 캐릭터 라인, 또는 null 인 경우, 동작은 구현 의존입니다.

getEncoding

String  getEncoding()

기존의 경우는 문자 인코딩입니다. 인코딩은 XML 인코딩 선언 (「XML 1.0」섹션 4.3. 3 「엔티티의 문자 인코딩」)로 받아들이고 가능한 캐릭터 라인으로 할 필요가 있습니다.
이 속성은 어플리케이션이 문자 스트림이나 캐릭터 라인 데이터를 제공하는 경우, 아무것도 영향을 주지 않습니다. 다른 입력 소스의 경우, XML 선언이나 텍스트 선언, 혹은 HTTP 「IETF RFC 2616」(이)라고 한 고위 레벨의 프로토콜로부터 취득된 인코딩은 이 속성을 사용해 지정된 인코딩에 의해 오버라이드(override) 됩니다.

setEncoding

void setEncoding(String  encoding)

기존의 경우는 문자 인코딩입니다. 인코딩은 XML 인코딩 선언 (「XML 1.0」섹션 4.3. 3 「엔티티의 문자 인코딩」)로 받아들이고 가능한 캐릭터 라인으로 할 필요가 있습니다.
이 속성은 어플리케이션이 문자 스트림이나 캐릭터 라인 데이터를 제공하는 경우, 아무것도 영향을 주지 않습니다. 다른 입력 소스의 경우, XML 선언이나 텍스트 선언, 혹은 HTTP 「IETF RFC 2616」(이)라고 한 고위 레벨의 프로토콜로부터 취득된 인코딩은 이 속성을 사용해 지정된 인코딩에 의해 오버라이드(override) 됩니다.

getCertifiedText

boolean getCertifiedText()

true 로 설정하는 경우, 입력은 해석시 (「XML 1.1」)에 증명되는 것을 전제로 합니다 (「XML 1.1」의 섹션 2.13을 참조).

setCertifiedText

void setCertifiedText(boolean certifiedText)

true 로 설정하는 경우, 입력은 해석시 (「XML 1.1」)에 증명되는 것을 전제로 합니다 (「XML 1.1」의 섹션 2.13을 참조).