com.xmlmind.xml.load

Class DTDSpec

java.lang.Object

com.xmlmind.xml.load.DTDSpec

public final class DTDSpec
extends Object

Models the contents of a DTD. Note that the declaration of internal, external and unparsed entities are modelled by another object: Entities.

Field Summary

Fields

Modifier and Type	Field and Description
URL	baseURL The URL against which a relative system ID of the DTD should be resolved.
String	documentTypeName The document type name.
String	publicId The public ID of the DTD, if any.
String	systemId The system ID of the DTD.

Constructor Summary

Constructors

Constructor and Description
DTDSpec(String documentTypeName, String publicId, String systemId, URL baseURL) Constructs an empty DTD specification containing no declarations at all.
DTDSpec(String documentTypeName, String publicId, String systemId, URL baseURL, Decl[] externalSubsetDecls) Constructs DTD specification containing specified external subset.

Method Summary

Modifier and Type	Method and Description
AttributeDecl	attributeDecl(String eName, String aName, String type, String mode, String value, boolean fromExternalSubset) Adds specified attribute declaration to this DTD specification.
ElementDecl	elementDecl(String name, String model, boolean fromExternalSubset) Adds specified element declaration to this DTD specification.
boolean	externalSubsetIsGrammar() Returns true if the external subset of this DTD is a grammar (contains declarations of elements and not just declarations of entities); otherwise returns false.
Decl[]	getExternalSubsetDecls() Returns the (possibly empty) array containing all declarations found in the external subset of this DTD.
URL	getExternalSubsetURL() Returns the fully resolved, possibly using XML catalogs, URL of the external subset of this DTD.
Decl[]	getInternalSubsetDecls() Returns the (possibly empty) array containing all declarations found in the internal subset of this DTD.
byte	getInternalSubsetFlag() Not for public use: returns the internal subset flag.
boolean	internalSubsetIsGrammar() Returns true if the internal subset of this DTD is a grammar (contains declarations of elements and not just declarations of entities); otherwise returns false.
boolean	isGrammar() Returns true if this DTD is a grammar (contains declarations of elements and not just declarations of entities); otherwise returns false.
NotationDecl	notationDecl(String name, String publicId, String systemId, URL baseURL, boolean fromExternalSubset) Adds specified notation declaration to this DTD specification.
void	setInternalSubsetFlag(int internalSubsetFlag) Not for public use: specifies the internal subset flag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

documentTypeName

public final String documentTypeName

The document type name. That is, "foo" if the documents starts with "<!DOCTYPE foo...".

publicId

public final String publicId

The public ID of the DTD, if any. May be null.

systemId

public final String systemId

The system ID of the DTD. If this URI is relative, it is to be resolved against baseURL.

baseURL

public final URL baseURL

The URL against which a relative system ID of the DTD should be resolved.

See Also:

systemId

Constructor Detail

DTDSpec

public DTDSpec(String documentTypeName,
               String publicId,
               String systemId,
               URL baseURL)

Constructs an empty DTD specification containing no declarations at all. These declarations are expected to be added later using elementDecl(java.lang.String, java.lang.String, boolean), elementDecl(java.lang.String, java.lang.String, boolean), notationDecl(java.lang.String, java.lang.String, java.lang.String, java.net.URL, boolean).

Parameters:

documentTypeName - The document type name.

publicId - The public ID of the DTD, if any. May be null.

systemId - The system ID of the DTD.

baseURL - The URL against which a relative system ID of the DTD should be resolved.

DTDSpec

public DTDSpec(String documentTypeName,
               String publicId,
               String systemId,
               URL baseURL,
               Decl[] externalSubsetDecls)

Constructs DTD specification containing specified external subset.

Parameters:

documentTypeName - The document type name.

publicId - The public ID of the DTD, if any. May be null.

systemId - The system ID of the DTD.

baseURL - The URL against which a relative system ID of the DTD should be resolved.

externalSubsetDecls - Declarations found in the external subset of this DTD.

Method Detail

elementDecl

public ElementDecl elementDecl(String name,
                               String model,
                               boolean fromExternalSubset)

Adds specified element declaration to this DTD specification.

Parameters:

name - Qualified name of the element.

model - Content model of the element (as found in the DTD).

fromExternalSubset - If true, this declaration is found in the external subset. If false, this declaration is found in the internal subset.

Returns:

newly added declaration

attributeDecl

public AttributeDecl attributeDecl(String eName,
                                   String aName,
                                   String type,
                                   String mode,
                                   String value,
                                   boolean fromExternalSubset)

Adds specified attribute declaration to this DTD specification.

Parameters:

eName - Qualified name of the elemen having the attribute.

aName - Qualified name of the attribute.

type - Type of the attribute: CDATA, ID, IDREF, etc.

mode - Mode of the attribute: #IMPLIED, #REQUIRED, #FIXED.

value - Value of the attribute. Enumerated values are separated by character '|'.

fromExternalSubset - If true, this declaration is found in the external subset. If false, this declaration is found in the internal subset.

Returns:

newly added declaration

notationDecl

public NotationDecl notationDecl(String name,
                                 String publicId,
                                 String systemId,
                                 URL baseURL,
                                 boolean fromExternalSubset)

Adds specified notation declaration to this DTD specification.

Parameters:

name - The name of the notation.

publicId - The public ID of the notation, if any. May be null.

systemId - The system ID of the notation.

baseURL - The URL against which a relative system ID of the notation should be resolved.

fromExternalSubset - If true, this declaration is found in the external subset. If false, this declaration is found in the internal subset.

Returns:

newly added declaration

setInternalSubsetFlag

public void setInternalSubsetFlag(int internalSubsetFlag)

Not for public use: specifies the internal subset flag.

Parameters:

internalSubsetFlag - -1=not set, 0=declarations not influenced by the presence of an internal subset, 1=declarations possibly influenced by the presence of an internal subset.

getInternalSubsetFlag

public byte getInternalSubsetFlag()

Not for public use: returns the internal subset flag.

getInternalSubsetDecls

public Decl[] getInternalSubsetDecls()

Returns the (possibly empty) array containing all declarations found in the internal subset of this DTD.

getExternalSubsetDecls

public Decl[] getExternalSubsetDecls()

Returns the (possibly empty) array containing all declarations found in the external subset of this DTD.

isGrammar

public boolean isGrammar()

Returns true if this DTD is a grammar (contains declarations of elements and not just declarations of entities); otherwise returns false.

externalSubsetIsGrammar

public boolean externalSubsetIsGrammar()

Returns true if the external subset of this DTD is a grammar (contains declarations of elements and not just declarations of entities); otherwise returns false.

internalSubsetIsGrammar

public boolean internalSubsetIsGrammar()

Returns true if the internal subset of this DTD is a grammar (contains declarations of elements and not just declarations of entities); otherwise returns false.

getExternalSubsetURL

public URL getExternalSubsetURL()

Returns the fully resolved, possibly using XML catalogs, URL of the external subset of this DTD. Returns null if this URL is unknown or malformed.