org.pentaho.reporting.libraries.xmlns.parser

Class DefaultXmlDocumentInfo

public class DefaultXmlDocumentInfo extends Object implements XmlDocumentInfo

A data class that holds all relevant information about a XML document to make a decision on what parser to use to interpret the XML content.

Author: Thomas Morgner

Constructor Summary
DefaultXmlDocumentInfo()
Default-Constructor.
Method Summary
StringgetDefaultNameSpace()
Returns the default-namespace declared on the root-element.
StringgetPublicDTDId()
Returns the Public-ID of the Document's DTD (if there's any).
StringgetRootElement()
Returns the tag name of the root-level element.
AttributesgetRootElementAttributes()
StringgetRootElementNameSpace()
Returns the namespace URI for the root-element of the document.
StringgetSystemDTDId()
Returns the System-ID of the document's DTD.
voidsetDefaultNameSpace(String defaultNameSpace)
Defines the default-namespace declared on the root-element.
voidsetPublicDTDId(String publicDTDId)
Defines the Public-ID of the Document's DTD (if there's any).
voidsetRootElement(String rootElement)
Defines the tag name of the root-level element.
voidsetRootElementAttributes(Attributes rootElementAttributes)
voidsetRootElementNameSpace(String rootElementNameSpace)
Defines the namespace URI for the root-element of the document.
voidsetSystemDTDId(String systemDTDId)
Defines the System-ID of the document's DTD.
StringtoString()
Returns a string representation of the document info.

Constructor Detail

DefaultXmlDocumentInfo

public DefaultXmlDocumentInfo()
Default-Constructor.

Method Detail

getDefaultNameSpace

public String getDefaultNameSpace()
Returns the default-namespace declared on the root-element. It is not guaranteed that this information is filled until a XmlFactoryModule has been selected.

Returns: the default-namespace.

getPublicDTDId

public String getPublicDTDId()
Returns the Public-ID of the Document's DTD (if there's any).

Returns: the public id.

getRootElement

public String getRootElement()
Returns the tag name of the root-level element.

Returns: the root-tag-name.

getRootElementAttributes

public Attributes getRootElementAttributes()

getRootElementNameSpace

public String getRootElementNameSpace()
Returns the namespace URI for the root-element of the document.

Returns: the namespace of the root-element.

getSystemDTDId

public String getSystemDTDId()
Returns the System-ID of the document's DTD.

Returns: the system-id.

setDefaultNameSpace

public void setDefaultNameSpace(String defaultNameSpace)
Defines the default-namespace declared on the root-element. It is not guaranteed that this information is filled until a XmlFactoryModule has been selected.

Parameters: defaultNameSpace the default-namespace.

setPublicDTDId

public void setPublicDTDId(String publicDTDId)
Defines the Public-ID of the Document's DTD (if there's any).

Parameters: publicDTDId the public id.

setRootElement

public void setRootElement(String rootElement)
Defines the tag name of the root-level element.

Parameters: rootElement the root-tag-name.

setRootElementAttributes

public void setRootElementAttributes(Attributes rootElementAttributes)

setRootElementNameSpace

public void setRootElementNameSpace(String rootElementNameSpace)
Defines the namespace URI for the root-element of the document.

Parameters: rootElementNameSpace the namespace of the root-element.

setSystemDTDId

public void setSystemDTDId(String systemDTDId)
Defines the System-ID of the document's DTD.

Parameters: systemDTDId the system-id.

toString

public String toString()
Returns a string representation of the document info. This is for debugging purposes only.

Returns: the string version of the document info.