Interface AbstractCMLDocument

All Superinterfaces:

CMLNode, Document, Node, PMRDocument

All Known Implementing Classes:

AbstractCMLDocumentImpl

public interface AbstractCMLDocument
extends PMRDocument, CMLNode

CORE InterfaceDTD ClassThe interface for any Document objects There are NO Core Methods.

Since:

1.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_OUTPUT_DTD	The default DTD file name for CML output.
static final String	DEFAULT_OUTPUT_ENCODING	The default character encoding used for CML output.
static final String	DEFAULT_OUTPUT_NAMESPACE	The default namespace URI for CML output.
static final String	NULL_DTD	Constant representing an empty or null DTD identifier.
static final String	NULL_NAMESPACE	Constant representing a null namespace identifier.
static final String	PACKAGE_NAME	the package name

Fields inherited from interface CMLNode

ARRAY, CML1, CML2

Fields inherited from interface Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Method Summary

Modifier and Type	Method	Description
AbstractBase	clone(AbstractBase element)	clone element in context of document.
AbstractBase	createAbstractBase()	creates new AbstractBase
Element	createSubclassedElement(String tagName)	creates new Element of given subclass
boolean	getDebug()	debug status
Element[]	getElementList(String name)	gets all element of given type (included nested children)
Vector<Element>	getElementVector(String name)	gets all element of given type (included nested children)
Element	getFirstElement(String name)	gets first element of given type
void	setDebug(boolean d)	toggle debugging
Element	subclass(Element oldEl)	Wraps an existing W3C Element in a CML-specific subclass implementation.
void	updateDelegates()	update delegates. updates documentElement delegates (content and attributes) then recurses through children
void	updateDOM()	update DOM. updates documentElement DOM (content and attributes) then recurses through children

Methods inherited from interface CMLNode

setArraySyntax, setVersion, writeXML, writeXML

Methods inherited from interface Document

adoptNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion

Methods inherited from interface Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Details

PACKAGE_NAME

static final String PACKAGE_NAME

the package name

See Also:

• Constant Field Values

NULL_DTD

static final String NULL_DTD

Constant representing an empty or null DTD identifier.

See Also:

• Constant Field Values

NULL_NAMESPACE

static final String NULL_NAMESPACE

Constant representing a null namespace identifier.

See Also:

• Constant Field Values

DEFAULT_OUTPUT_ENCODING

static final String DEFAULT_OUTPUT_ENCODING

The default character encoding used for CML output.

See Also:

• Constant Field Values

DEFAULT_OUTPUT_DTD

static final String DEFAULT_OUTPUT_DTD

The default DTD file name for CML output.

See Also:

• Constant Field Values

DEFAULT_OUTPUT_NAMESPACE

static final String DEFAULT_OUTPUT_NAMESPACE

The default namespace URI for CML output.

See Also:

• Constant Field Values

Method Details

getFirstElement

Element getFirstElement(String name)

gets first element of given type

Parameters:

name - element to return

Returns:

Element the element (null if none)

getElementVector

Vector<Element> getElementVector(String name)

gets all element of given type (included nested children)

Parameters:

name - elements to return

Returns:

Vector of elements (empty if none)

getElementList

Element[] getElementList(String name)

gets all element of given type (included nested children)

Parameters:

name - elements to return

Returns:

array of elements (empty if none)

createSubclassedElement

Element createSubclassedElement(String tagName)

creates new Element of given subclass

Parameters:

tagName - determines the class

Returns:

the new element

subclass

Element subclass(Element oldEl)

Wraps an existing W3C Element in a CML-specific subclass implementation.

Parameters:

oldEl - the generic W3C element to subclass

Returns:

the subclassed element instance

createAbstractBase

AbstractBase createAbstractBase()

creates new AbstractBase

Returns:

the new element

setDebug

void setDebug(boolean d)

toggle debugging

Parameters:

d - debug

getDebug

boolean getDebug()

debug status

Returns:

is debug set

clone

AbstractBase clone(AbstractBase element)
            throws CMLException

clone element in context of document.

Parameters:

element - to clone (may or may not be owned by this)

Returns:

the cloned element (owner is this)

Throws:

CMLException - cannot clone non-AbstractBase

updateDelegates

void updateDelegates()

update delegates. updates documentElement delegates (content and attributes) then recurses through children

updateDOM

void updateDOM()

update DOM. updates documentElement DOM (content and attributes) then recurses through children