org.pentaho.reporting.libraries.xmlns.parser

Class DefaultXmlDocumentInfo

java.lang.Object

org.pentaho.reporting.libraries.xmlns.parser.DefaultXmlDocumentInfo

All Implemented Interfaces:

XmlDocumentInfo

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

Constructors

Constructor and Description
DefaultXmlDocumentInfo() Default-Constructor.

Method Summary

Modifier and Type	Method and Description
String	getDefaultNameSpace() Returns the default-namespace declared on the root-element.
String	getPublicDTDId() Returns the Public-ID of the Document's DTD (if there's any).
String	getRootElement() Returns the tag name of the root-level element.
Attributes	getRootElementAttributes()
String	getRootElementNameSpace() Returns the namespace URI for the root-element of the document.
String	getSystemDTDId() Returns the System-ID of the document's DTD.
void	setDefaultNameSpace(String defaultNameSpace) Defines the default-namespace declared on the root-element.
void	setPublicDTDId(String publicDTDId) Defines the Public-ID of the Document's DTD (if there's any).
void	setRootElement(String rootElement) Defines the tag name of the root-level element.
void	setRootElementAttributes(Attributes rootElementAttributes)
void	setRootElementNameSpace(String rootElementNameSpace) Defines the namespace URI for the root-element of the document.
void	setSystemDTDId(String systemDTDId) Defines the System-ID of the document's DTD.
String	toString() Returns a string representation of the document info.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultXmlDocumentInfo

public DefaultXmlDocumentInfo()

Default-Constructor.

Method Detail

getRootElement

public String getRootElement()

Returns the tag name of the root-level element.

Specified by:

getRootElement in interface XmlDocumentInfo

Returns:

the root-tag-name.

setRootElement

public void setRootElement(String rootElement)

Defines the tag name of the root-level element.

Parameters:

rootElement - the root-tag-name.

getRootElementNameSpace

public String getRootElementNameSpace()

Returns the namespace URI for the root-element of the document.

Specified by:

getRootElementNameSpace in interface XmlDocumentInfo

Returns:

the namespace of the root-element.

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.

getRootElementAttributes

public Attributes getRootElementAttributes()

Specified by:

getRootElementAttributes in interface XmlDocumentInfo

setRootElementAttributes

public void setRootElementAttributes(Attributes rootElementAttributes)

getPublicDTDId

public String getPublicDTDId()

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

Specified by:

getPublicDTDId in interface XmlDocumentInfo

Returns:

the public id.

setPublicDTDId

public void setPublicDTDId(String publicDTDId)

Defines the Public-ID of the Document's DTD (if there's any).

Parameters:

publicDTDId - the public id.

getSystemDTDId

public String getSystemDTDId()

Returns the System-ID of the document's DTD.

Specified by:

getSystemDTDId in interface XmlDocumentInfo

Returns:

the system-id.

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.

Overrides:

toString in class Object

Returns:

the string version of the document info.

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.

Specified by:

getDefaultNameSpace in interface XmlDocumentInfo

Returns:

the default-namespace.

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.