org.mmbase.util.xml

Class ModuleReader

java.lang.Object

org.mmbase.util.xml.DocumentReader

org.mmbase.util.xml.ModuleReader

public class ModuleReader
extends DocumentReader

Since:

MMBase-1.8

Version:

$Id$

Author:

Daniel Ockeloen, Pierre van Rooden

Javadoc:

Field Summary

Fields

Modifier and Type	Field and Description
static String	DTD_MODULE DTD resource filename of the most recent Module DTD
static String	DTD_MODULE_1_0 DTD resource filename of the most recent Module DTD
static String	NAMESPACE_MODULE
static String	NAMESPACE_MODULE_2_0
static String	PUBLIC_ID_MODULE Public ID of the most recent Module DTD
static String	PUBLIC_ID_MODULE_1_0 Public ID of the Module DTD version 1.0
static String	XSD_MODULE_2_0

Fields inherited from class org.mmbase.util.xml.DocumentReader

document, DTD_ERROR, DTD_ERROR_1_0, FILENOTFOUND, PUBLIC_ID_ERROR, PUBLIC_ID_ERROR_1_0, utilProperties

Constructor Summary

Constructors

Constructor and Description
ModuleReader(Document doc)
ModuleReader(InputSource is)

Method Summary

Modifier and Type	Method and Description
String	getClassName() The name of the class which is implementing this Module.
LocalizedString	getLocalizedDescription(LocalizedString description) Get the descriptions of this module.
LocalizedString	getLocalizedGUIName(LocalizedString guiName) Get the (gui) names of this module.
String	getMaintainer() Get the maintainer of this module
String	getName() Get the name of this module.
Map<String,String>	getProperties() Get the properties of this builder
String	getStatus() Get the status of this module
String	getURLString() get the optional resource url for the module
int	getVersion() Get the version of this module
static void	registerPublicIDs() Register the Public Ids for DTDs used by ModuleReader This method is called by EntityResolver.
static void	registerSystemIDs() Register the namespace and XSD used by DataTypeConfigurer This method is called by EntityResolver.

Methods inherited from class org.mmbase.util.xml.DocumentReader

appendChild, getAttribute, getChildElements, getChildElements, getChildElements, getChildElements, getDocument, getDocumentBuilder, getDocumentBuilder, getDocumentBuilder, getDocumentBuilder, getElementAttributeValue, getElementAttributeValue, getElementByPath, getElementByPath, getElementName, getElementValue, getElementValue, getNodeTextValue, getNodeTextValue, getRootElement, getSystemId, hasAttribute, main, setNodeTextValue, setPrefix, setSystemId, toDocument, validate, validate

Methods inherited from class java.lang.Object

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

Field Detail

PUBLIC_ID_MODULE_1_0

public static final String PUBLIC_ID_MODULE_1_0

Public ID of the Module DTD version 1.0

See Also:

Constant Field Values

PUBLIC_ID_MODULE

public static final String PUBLIC_ID_MODULE

Public ID of the most recent Module DTD

See Also:

Constant Field Values

DTD_MODULE_1_0

public static final String DTD_MODULE_1_0

DTD resource filename of the most recent Module DTD

See Also:

Constant Field Values

DTD_MODULE

public static final String DTD_MODULE

DTD resource filename of the most recent Module DTD

See Also:

Constant Field Values

XSD_MODULE_2_0

public static final String XSD_MODULE_2_0

See Also:

Constant Field Values

NAMESPACE_MODULE_2_0

public static final String NAMESPACE_MODULE_2_0

See Also:

Constant Field Values

NAMESPACE_MODULE

public static final String NAMESPACE_MODULE

See Also:

Constant Field Values

Constructor Detail

ModuleReader

public ModuleReader(InputSource is)

ModuleReader

public ModuleReader(Document doc)

Since:

MMBase-1.8

Method Detail

registerSystemIDs

public static void registerSystemIDs()

Register the namespace and XSD used by DataTypeConfigurer This method is called by EntityResolver.

registerPublicIDs

public static void registerPublicIDs()

Register the Public Ids for DTDs used by ModuleReader This method is called by EntityResolver.

Since:

MMBase-1.7

getStatus

public String getStatus()

Get the status of this module

getVersion

public int getVersion()

Get the version of this module

getName

public String getName()

Get the name of this module. Returns null if no name is found.

Since:

MMBase-1.9

getMaintainer

public String getMaintainer()

Get the maintainer of this module

getClassName

public String getClassName()

The name of the class which is implementing this Module.

getURLString

public String getURLString()

get the optional resource url for the module

Returns:

the url of the resource or null if no url was defined

getLocalizedDescription

public LocalizedString getLocalizedDescription(LocalizedString description)

Get the descriptions of this module.

Returns:

the descriptions as a LocalizedString

getLocalizedGUIName

public LocalizedString getLocalizedGUIName(LocalizedString guiName)

Get the (gui) names of this module.

Returns:

the names as a LocalizedString

getProperties

public Map<String,String> getProperties()

Get the properties of this builder