matlab.io.xml.dom.Entity class

Package: matlab.io.xml.dom

Entity defined by document type

Since R2021a

Description

An object of the matlab.io.xml.dom.Entity class represents an XML entity. An XML entity is document content that has a name and is defined by a document type definition associated with a document. The getEntities method of a matlab.io.xml.dom.DocumentType object returns a list of the entities defined by the document type as a matlab.io.xml.dom.NamedNodeMap object. Use the item method of the NamedNodeMap object to return an Entity object that is in the list.

Note

An Entity object inherits methods and properties from the matlab.io.xml.dom.Node class that are ineffective or cause errors when used with an Entity object. Use only the methods and properties documented on this page.

The matlab.io.xml.dom.Entity class is a handle class.

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Properties

InputEncoding — Encoding of entity source document

character vector

Encoding of the entity source document, specified as a character vector.

Attributes:

GetAccess	public
SetAccess	immutable
Transient	true
NonCopyable	true

PublicID — Public ID of entity source document

character vector

Public ID of the entity source document, specified as a character vector. The property value is set to the public ID specified by the document type declaration from which this entity was parsed.

Attributes:

GetAccess	public
SetAccess	immutable
Transient	true
NonCopyable	true

SystemID — System ID of entity source document

character vector

System ID of the entity source document, specified as a character vector. The property value is set to the location specified by the document type declaration from which this entity was parsed.

Attributes:

GetAccess	public
SetAccess	immutable
Transient	true
NonCopyable	true

XMLEncoding — Encoding specified by XML declaration

character vector

Encoding specified by the XML declaration in the source file from which this entity was parsed, specified as a character vector.

Attributes:

GetAccess	public
SetAccess	immutable
Transient	true
NonCopyable	true

XMLVersion — XML version specified by XML declaration

character vector

XML version specified by the XML declaration in the source file from which this entity was parsed, specified as a character vector.

Attributes:

GetAccess	public
SetAccess	immutable
Transient	true
NonCopyable	true

Methods

Public Methods

getInputEncoding	encoding = getInputEncoding(thisEntity) returns the encoding used to parse the XML file specified by this entity. This method returns an encoding only if the entity specifies an XML file and the specified file has been parsed.
getNodeName	name = getNodeName(thisEntity) returns the name of this entity as a character vector.
getNotationName	name = getNotationName(thisEntity) returns the name of the notation associated with this file entity as a character vector. A notation typically specifies the type of an unparsed file, such as an image file. The method returns an empty character vector for character entities and for entities that specify parsed files, such as XML files.
getPublicID	id = getPublicID(thisEntity) returns the public ID of this entity as a character vector.
getSystemID	id = getSystemID(thisEntity) returns the system ID (location) of this entity as a character vector.
getXMLEncoding	encoding = getXMLEncoding(thisEntity) returns the encoding of the file specified by this entity as a character vector. The method returns an encoding only if the entity specifies an XML file, the specified file has been parsed, and the parser was able to determine the encoding. Otherwise, the method returns an empty character vector.
getXMLVersion	version = getXMLVersion(thisEntity) returns the XML version to which the file specified by this entity conforms, specified as a character vector. The method returns a version only if the entity specifies an XML file, the specified file as been parsed, and the parsed file specifies an XML version. Otherwise, this method returns an empty character vector.

Examples

Access Document Type and Entities in Parsed Document

This example shows how to access document type and entity information in a DOM document that was parsed from XML markup that contains a document type definition (DTD).

The example uses these files, which must all be in the same folder:

• book.xml contains a document type definition that declares that the resource for the chapter entity is chapter.xml.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book [
<!ENTITY chapter SYSTEM "chapter.xml">
]>
<book>
    &chapter;
</book>

• chapter.xml contains markup for a chapter.

<?xml version="1.0" encoding="UTF-8"?>
<chapter><title color="red">Introduction</title></chapter>

Parse the XML into a matlab.io.xml.dom.Document object.

import matlab.io.xml.dom.*

myParser = Parser;
myParser.Configuration.AllowDoctype = true;
doc = parseFile(myParser,'book.xml');

To get information about the document type, use the getDoctype method of the Document object.

docTypeObj = getDoctype(doc)

docTypeObj = 
  DocumentType with properties:

              Name: 'book'
          PublicID: ''
          SystemID: ''
    InternalSubset: '↵<!ENTITY chapter SYSTEM "chapter.xml">↵'
       TextContent: ''
          Children: [1×0 matlab.io.xml.dom.Node]

To get information about the entities defined by the document type, use the getEntities method of the DocumentType object. The method returns a list of the entities as a NamedNodeMap object.

namedNodeMapObj = getEntities(docTypeObj);

To return the matlab.io.xm.dom.Entity objects that represent the entities, use the item method of the NamedNodeMap object. Specify the first index as 0.

n = getLength(namedNodeMapObj)-1;
for i=0:n
    item(namedNodeMapObj,i)
end

ans = 
  Entity with properties:

    InputEncoding: 'UTF-8'
         PublicID: ''
         SystemID: 'chapter.xml'
      XMLEncoding: 'UTF-8'
       XMLVersion: '1.0'
      TextContent: '↵Introduction'
         Children: [1×2 matlab.io.xml.dom.Node]

Version History

Introduced in R2021a