org.w3c.dom
인터페이스 Document

모든 슈퍼 인터페이스:

Node

public interface Document

extends Node

Document 인터페이스는 HTML 문서 또는 XML 문서 전체를 나타냅니다. 개념상은 문서 트리의 루트이며, 문서 데이터에의 일차 액세스를 제공합니다.

요소, 텍스트 노드, 코멘트, 처리 인스트럭션등의 오브젝트는 Document 의 문맥외에서는 존재 할 수 있지 않습니다. 이 때문에,Document 인터페이스에는 이러한 오브젝트를 작성하기 위해서 필요한 팩토리 메소드가 포함되어 있습니다. 작성된 Node 오브젝트는 그 작성 문맥내에서 자신과 Document 를 관련짓는 ownerDocument 속성을 가지고 있습니다.

「Document Object Model (DOM) Level 2 Core Specification」를 참조해 주세요.

필드의 개요

인터페이스 org.w3c.dom. Node 에서 상속받은 필드

ATTRIBUTE_NODE , CDATA_SECTION_NODE , COMMENT_NODE , DOCUMENT_FRAGMENT_NODE , DOCUMENT_NODE , DOCUMENT_TYPE_NODE , ELEMENT_NODE , ENTITY_NODE , ENTITY_REFERENCE_NODE , NOTATION_NODE , PROCESSING_INSTRUCTION_NODE , TEXT_NODE

메소드의 개요

Attr	createAttribute (String name) 소정의 이름의 Attr 를 작성합니다.
Attr	createAttributeNS (String namespaceURI, String qualifiedName) 소정의 수식명과 네임 스페이스 URI 를 가지는 속성을 작성합니다.
CDATASection	createCDATASection (String data) 지정된 캐릭터 라인을 값으로 해서 가지는 CDATASection 노드를 작성합니다.
Comment	createComment (String data) 지정된 캐릭터 라인을 가지는 Comment 노드를 작성합니다.
DocumentFragment	createDocumentFragment () 하늘의 DocumentFragment 오브젝트를 생성합니다.
Element	createElement (String tagName) 지정된 형태의 요소를 작성합니다.
Element	createElementNS (String namespaceURI, String qualifiedName) 소정의 수식명과 네임 스페이스 URI 를 가지는 요소를 작성합니다.
EntityReference	createEntityReference (String name) EntityReference 오브젝트를 작성합니다.
ProcessingInstruction	createProcessingInstruction (String target, String data) 지정된 이름 및 데이터를 가지는 ProcessingInstruction 노드를 작성합니다.
Text	createTextNode (String data) 지정된 캐릭터 라인을 가지는 Text 노드를 작성합니다.
DocumentType	getDoctype () 이 문서에 관련지을 수 있었던 문서 타입 선언입니다 (DocumentType 를 참조).
Element	getDocumentElement () 문서의 루트 요소가 되어 있는 아이 노드에의 직접 액세스를 가능하게 하는 편리한 속성입니다.
Element	getElementById (String elementId) elementId 로부터 주어진 ID 를 가지는 Element 를 돌려줍니다.
NodeList	getElementsByTagName (String tagname) 소정의 태그명과 함께, 모든 Elements 의 NodeList 를 돌려줍니다.
NodeList	getElementsByTagNameNS (String namespaceURI, String localName) 소정의 로컬명 및 네임 스페이스 URI 와 함께, 모든 Elements 의 NodeList 를 돌려줍니다.
DOMImplementation	getImplementation () 이 문서를 처리하는 DOMImplementation 오브젝트입니다.
Node	importNode (Node importedNode, boolean deep) 그 외의 문서로부터 현재의 문서에 노드를 임포트 합니다.

인터페이스 org.w3c.dom. Node 에서 상속받은 메소드

appendChild , cloneNode , getAttributes , getChildNodes , getFirstChild , getLastChild , getLocalName , getNamespaceURI , getNextSibling , getNodeName , getNodeType , getNodeValue , getOwnerDocument , getParentNode , getPrefix , getPreviousSibling , hasAttributes , hasChildNodes , insertBefore , isSupported , normalize , removeChild , replaceChild , setNodeValue , setPrefix

메소드의 상세

getDoctype

public DocumentType  getDoctype()

이 문서에 관련지을 수 있었던 문서 타입 선언입니다 (DocumentType 를 참조). 문서 타입 선언이 없는 XML 문서 및 HTML 문서에 대해서는 null 를 돌려줍니다. DOM 레벨 2 에서는 문서 타입 선언의 변경은 서포트되고 있지 않습니다. 어떠한 방법에 따라도,docType 를 변경할 수 없습니다. 예를 들어,Node 인터페이스로부터 계승된 메소드 (insertNode,removeNode 등)를 사용하는 방법도 허가되고 있지 않습니다.

getImplementation

public DOMImplementation  getImplementation()

이 문서를 처리하는 DOMImplementation 오브젝트입니다. DOM 어플리케이션은 복수의 구현의 오브젝트를 사용할 수 있습니다.

getDocumentElement

public Element  getDocumentElement()

문서의 루트 요소가 되어 있는 아이 노드에의 직접 액세스를 가능하게 하는 편리한 속성입니다. HTML 문서의 경우, 「HTML」라고 하는 tagName 를 가지는 요소가 이것에 해당합니다.

createElement

public Element  createElement(String  tagName)
                      throws DOMException 

지정된 형태의 요소를 작성합니다. 돌려주어지는 인스턴스는 Element 인터페이스를 구현하기 위해(때문에), 속성은 돌려주어지는 오브젝트에 직접 지정할 수 있습니다.
디폴트 값를 가지는 기존의 속성이 존재하는 경우는 이것들을 나타내는 Attr 노드가 자동적으로 작성되어 요소에 부가됩니다.
수식명과 네임 스페이스 URI 를 가지는 요소를 작성하려면 ,createElementNS 메소드를 사용합니다.

파라미터:

tagName - 인스턴스화하는 요소형의 이름. XML 의 경우, 알파벳의 대문자와 소문자가 구별된다. 이러한 구별은 HTML 의 tagName 파라미터에는 적용되지 않는다. 다만, DOM 구현은 이 파라미터를 대문자 (표준 사양)로 매핑 한다

반환값:

tagName 로 설정된 nodeName 속성,localName,prefix,null 로 설정된 namespaceURI 를 가지는 새로운 Element 오브젝트

예외:

DOMException - INVALID_CHARACTER_ERR: 지정된 이름에 부정한 캐릭터가 포함되어 있는 경우

createDocumentFragment

public DocumentFragment  createDocumentFragment()

하늘의 DocumentFragment 오브젝트를 생성합니다.

반환값:

새로운 DocumentFragment

createTextNode

public Text  createTextNode(String  data)

지정된 캐릭터 라인을 가지는 Text 노드를 작성합니다.

파라미터:

data - 노드의 데이터

반환값:

새로운 Text 오브젝트

createComment

public Comment  createComment(String  data)

지정된 캐릭터 라인을 가지는 Comment 노드를 작성합니다.

파라미터:

data - 노드의 데이터

반환값:

새로운 Comment 오브젝트

createCDATASection

public CDATASection  createCDATASection(String  data)
                                throws DOMException 

지정된 캐릭터 라인을 값으로 해서 가지는 CDATASection 노드를 작성합니다.

파라미터:

data - CDATASection 에 포함되는 데이터

반환값:

새로운 CDATASection 오브젝트

예외:

DOMException - NOT_SUPPORTED_ERR: 이 문서가 HTML 문서의 경우

createProcessingInstruction

public ProcessingInstruction  createProcessingInstruction(String  target,
                                                         String  data)
                                                  throws DOMException 

지정된 이름 및 데이터를 가지는 ProcessingInstruction 노드를 작성합니다.

파라미터:

target - 처리 인스트럭션의 타겟 부분

data - 노드의 데이터

반환값:

새로운 ProcessingInstruction 오브젝트

예외:

DOMException - INVALID_CHARACTER_ERR: 지정된 타겟으로 부정한 캐릭터가 포함되어 있는 경우
NOT_SUPPORTED_ERR: 이 문서가 HTML 문서의 경우

createAttribute

public Attr  createAttribute(String  name)
                     throws DOMException 

소정의 이름의 Attr 를 작성합니다. 그 후, 이 Attr 인스턴스는 setAttributeNode 메소드에 의해 Element 로 설정됩니다.
수식명과 네임 스페이스 URI 를 가지는 속성을 작성하려면 ,createAttributeNS 메소드를 사용합니다.

파라미터:

name - 속성의 이름

반환값:

name 로 설정된 nodeName 속성,localName,prefix,null 로 설정된 namespaceURI 를 가지는 새로운 Attr 오브젝트

예외:

DOMException - INVALID_CHARACTER_ERR: 지정된 이름에 부정한 캐릭터가 포함되어 있는 경우

createEntityReference

public EntityReference  createEntityReference(String  name)
                                      throws DOMException 

EntityReference 오브젝트를 작성합니다. 게다가 참조되는 엔티티가 기존의 경우는 Entity 노드의 아이 리스트가 작성되는 것과 같이,EntityReference 노드의 아이 리스트가 작성됩니다. Entity 노드의 자손이 바인드되어 있지 않은 네임 스페이스 수식자를 가지고 있는 경우, 작성된 EntityReference 노드의 대응하는 자손도 바인드 되고 있지 않습니다 (namespaceURI 가 null). DOM 레벨 2 에서는 네임 스페이스 수식자를 해결하는 메카니즘은 서포트되고 있지 않습니다.

파라미터:

name - 참조되는 엔티티의 이름

반환값:

새로운 EntityReference 오브젝트

예외:

DOMException - INVALID_CHARACTER_ERR: 지정된 이름에 부정한 캐릭터가 포함되어 있는 경우
NOT_SUPPORTED_ERR: 이 문서가 HTML 문서의 경우

getElementsByTagName

public NodeList  getElementsByTagName(String  tagname)

소정의 태그명과 함께, 모든 Elements 의 NodeList 를 돌려줍니다. 돌려주어지는 차례는 Document 트리의 선행순서 (preorder traversal)로 검출된 차례로 됩니다.

파라미터:

tagname - 일치하는 태그의 이름. 특수한 값 "*" 은 모든 태그에 일치한다

반환값:

일치하는 모든 Elements 를 포함한 새로운 NodeList 오브젝트

importNode

public Node  importNode(Node  importedNode,
                       boolean deep)
                throws DOMException 

그 외의 문서로부터 현재의 문서에 노드를 임포트 합니다. 돌려주어지는 노드는 친노드를 가지지 않습니다 (parentNode 가 null). 이 메소드는 원시 코드의 새로운 카피를 작성할 뿐입니다. 원의 문서의 소스 노드가 변경 또는 삭제될 것은 없습니다.
어느 노드를 임포트 해도, 임포트측의 문서를 소유원으로 하는 노드 오브젝트가 작성됩니다. 이 오브젝트는 소스 노드의 nodeName 및 nodeType 와 완전히 같은 속성치에 가세해, 네임 스페이스 관련 속성 (prefix,localName,namespaceURI)을 가지고 있습니다. Node 에 대한 cloneNode 조작의 경우와 같이, 소스 노드는 변경되지 않습니다.
추가 정보는 적절한 방법으로 nodeType 에 카피됩니다. XML 소스 또는 HTML 소스의 fragment가 한편의 문서로부터 이제(벌써) 한편의 문서에 카피되었을 경우, 2 개의 문서가 XML 케이스내에 다른 DTD 를 가질 가능성이 있는 것을 받아, 적절한 동작의 밀러화가 시행됩니다. 이하에서는 각 노드형의 특성을 해설합니다.

ATTRIBUTE_NODE

생성된 Attr 상에서,ownerElement 속성은 null,specified 플래그는 true 로 설정됩니다. 소스인 Attr 의 자손의 재귀적 임포트와 결과 노드의 재어셈블(assemble)에 의해, 대응하는 서브 트리가 형성됩니다. 덧붙여deep 파라미터는 Attr 노드에 영향을 미치지 않습니다. 이러한 파라미터는 아이와 함께 임포트 됩니다.

DOCUMENT_FRAGMENT_NODE

deep 옵션이 true 로 설정되어 있는 경우, 소스 요소의 자손의 재귀적 임포트와 결과 노드의 재어셈블(assemble)에 의해, 대응하는 서브 트리가 형성됩니다. 그 이외의 경우는 하늘의 DocumentFragment 가 생성될 뿐입니다.

DOCUMENT_NODE

Document 노드는 임포트 할 수 없습니다.

DOCUMENT_TYPE_NODE

DocumentType 노드는 임포트 할 수 없습니다.

ELEMENT_NODE

소스 요소의 지정된 속성 노드가 임포트 되어 생성된 Attr 노드가 같이 생성된 Element 에 추가됩니다. 임포트 되는 문서가 이 요소명의 디폴트 속성 (할당하고가 끝난 상태)을 정의하는 경우도, 디폴트 속성은 카피되지 않습니다. importNode 의 deep 파라미터가 true 로 설정되어 있는 경우는 소스 요소의 자손이 재귀적으로 임포트 되어 결과 노드가 재어셈블(assemble) 되어, 대응하는 서브 트리를 형성합니다.

ENTITY_NODE

DOM 의 최신 릴리스인 DocumentType 는 읽어내 전용입니다만,Entity 노드는 임포트 가능합니다. 이렇게 해 임포트 된 노드를 DocumentType 에 추가하는 기능은 장래의 DOM 의 릴리스로 추가될 예정입니다. 임포트시에는 publicId,systemId,notationName 의 각 속성이 카피됩니다. deep 의 임포트가 요구되었을 경우는 Entity (소스)의 자손이 재귀적으로 임포트 되어 결과 노드가 재어셈블(assemble) 되어, 대응하는 서브 트리를 형성합니다.

ENTITY_REFERENCE_NODE

deep 의 임포트가 요구되었을 경우도, 소스 문서와 데스티네이션 문서로 엔티티의 정의가 다른 경우가 있으므로,EntityReference 만이 카피되게 됩니다. 임포트 되는 문서가 이 엔트리명을 정의하는 경우는 그 값을 할당할 수 있습니다.

NOTATION_NODE

DOM 의 최신 릴리스인 DocumentType 는 읽어내 전용입니다만,Notation 노드는 임포트 가능합니다. 이렇게 해 임포트 된 노드를 DocumentType 에 추가하는 기능은 장래의 DOM 의 릴리스로 추가될 예정입니다. 임포트시에는 publicId 속성과 systemId 속성이 카피됩니다. 아이를 가지는 것이 없는 deep 파라미터는 Notation 노드에 대해서 어떤 영향도 미치지 않습니다.

PROCESSING_INSTRUCTION_NODE

임포트 된 노드는 소스 노드로부터 target 와 data 의 값을 카피합니다.

TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE

CharacterData 를 계승하는 3 개의 노드형입니다. 자신의 data 속성과 length 속성을 소스 노드로부터 카피합니다.

파라미터:

importedNode - 임포트 되는 노드

deep - true 의 경우는 지정된 노드의 서브 트리를 임포트 해,false 의 경우는 지정된 노드만을 임포트 한다 (상기의 설명을 참조). Attr,EntityReference,Notation 의 각 노드에는 영향을 미치지 않는다

반환값:

이 Document 에 소속하는 임포트 된 노드

예외:

DOMException - NOT_SUPPORTED_ERR: 임포트 되는 노드형이 서포트 대상외의 경우

도입된 버젼:

DOM Level 2

createElementNS

public Element  createElementNS(String  namespaceURI,
                               String  qualifiedName)
                        throws DOMException 

소정의 수식명과 네임 스페이스 URI 를 가지는 요소를 작성합니다.

파라미터:

namespaceURI - 작성하는 요소의 네임 스페이스 URI

qualifiedName - 인스턴스화하는 요소형의 수식명

반환값:

이하의 속성을 가지는 새로운 Element 오브젝트:

속성	치
Node.nodeName	qualifiedName
Node.namespaceURI	namespaceURI
Node.prefix	qualifiedName 로부터 추출된 전치수식자. 전치수식자가 존재하지 않는 경우는 null
Node.localName	qualifiedName로부터 추출된 로컬명
Element.tagName	qualifiedName

예외:

DOMException - INVALID_CHARACTER_ERR: 지정된 수식명에 XML 1.0 사양에 정해져 있는 부정한 캐릭터가 포함되어 있는 경우
NAMESPACE_ERR: qualifiedName 가 XML 사양의 네임 스페이스의 정의에 따른 것 나오지 않는 경우. qualifiedName 가 전치수식자를 가져,namespaceURI 가 null 의 경우. qualifiedName 가 전치수식자 "xml" 를 가져,namespaceURI 가 "http://www.w3.org/XML/1998/namespace" 이외인 경우
NOT_SUPPORTED_ERR: 현재의 문서가 "XML" 를 서포트하지 않는 경우 (네임 스페이스는 XML 에 의해 정의되고 있다)

도입된 버젼:

DOM Level 2

createAttributeNS

public Attr  createAttributeNS(String  namespaceURI,
                              String  qualifiedName)
                       throws DOMException 

소정의 수식명과 네임 스페이스 URI 를 가지는 속성을 작성합니다.

파라미터:

namespaceURI - 작성하는 속성의 네임 스페이스 URI

qualifiedName - 인스턴스화하는 속성의 수식명

반환값:

이하의 속성을 가지는 새로운 Attr 오브젝트: qualifiedNameNode.namespaceURI

예외:

DOMException - INVALID_CHARACTER_ERR: 지정된 수식명에 XML 1.0 사양에 정해져 있는 부정한 캐릭터가 포함되어 있는 경우
NAMESPACE_ERR: qualifiedName 가 XML 사양의 네임 스페이스의 정의에 따른 것 나오지 않는 경우. qualifiedName 가 전치수식자를 가져,namespaceURI 가 null 의 경우. qualifiedName 가 전치수식자 "xml" 를 가져,namespaceURI 가 "http://www.w3.org/2000/xmlns/ 이외인 경우. qualifiedName 또는 그 전치수식자가 "xmlns" 이며,namespaceURI 가 "http://www.w3.org/2000/xmlns/" 이외인 경우
NOT_SUPPORTED_ERR: 현재의 문서가 "XML" 를 서포트하지 않는 경우 (네임 스페이스는 XML 에 의해 정의되고 있다)

도입된 버젼:

DOM Level 2

getElementsByTagNameNS

public NodeList  getElementsByTagNameNS(String  namespaceURI,
                                       String  localName)

소정의 로컬명 및 네임 스페이스 URI 와 함께, 모든 Elements 의 NodeList 를 돌려줍니다. 돌려주어지는 차례는 Document 트리의 선행순서 (preorder traversal)로 검출된 차례로 됩니다.

파라미터:

namespaceURI - 일치하는 요소의 네임 스페이스 URI. 특수한 값 "*" 은 모든 네임 스페이스에 일치하는

localName - 일치하는 요소의 로컬명. 특수한 값 "*" 은 모든 로컬명에 일치한다

반환값:

일치하는 모든 Elements 를 포함한 새로운 NodeList 오브젝트

도입된 버젼:

DOM Level 2

getElementById

public Element  getElementById(String  elementId)

elementId 로부터 주어진 ID 를 가지는 Element 를 돌려줍니다. 이러한 요소가 존재하지 않는 경우는 null 를 돌려줍니다. 복수의 요소가 이 ID 를 가지고 있는 경우의 동작은 미정도리입니다. DOM 구현은 어느 속성이 ID 형의 속성인가를 특정할 수 없으면 안됩니다. "ID" 라는 이름을 가지고 있어도, 그처럼 정의되어 있지 않으면, ID 형의 속성이 아닙니다. 어느 속성이 ID 형의 속성인가를 특정할 수 없는 경우, 구현은 null 를 돌려줍니다.

파라미터:

elementId - 요소의 일의의 id 치

반환값:

일치하는 요소

도입된 버젼:

DOM Level 2