com.rometools.rome.io.impl

Class DCModuleGenerator

java.lang.Object

com.rometools.rome.io.impl.DCModuleGenerator

All Implemented Interfaces:

ModuleGenerator

public class DCModuleGenerator
extends java.lang.Object
implements ModuleGenerator

Feed Generator for DublinCore Module.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.jdom2.Namespace	DC_NS
private static java.lang.String	DC_URI
private static java.util.Set<org.jdom2.Namespace>	NAMESPACES
private static org.jdom2.Namespace	RDF_NS
private static java.lang.String	RDF_URI
private static org.jdom2.Namespace	TAXO_NS
private static java.lang.String	TAXO_URI

Constructor Summary

Constructors

Constructor and Description
DCModuleGenerator()

Method Summary

Modifier and Type	Method and Description
void	generate(Module module, org.jdom2.Element element) Populate an element tree with elements for a module.
protected org.jdom2.Element	generateSimpleElement(java.lang.String name, java.lang.String value) Utility method to generate a single element containing a string.
protected java.util.List<org.jdom2.Element>	generateSimpleElementList(java.lang.String name, java.util.List<java.lang.String> values) Utility method to generate a list of simple elements.
protected org.jdom2.Element	generateSubjectElement(DCSubject subject) Utility method to generate an element for a subject.
private org.jdom2.Namespace	getDCNamespace()
java.util.Set<org.jdom2.Namespace>	getNamespaces() Returns a set with all the URIs (JDOM Namespace elements) this module generator uses.
java.lang.String	getNamespaceUri() Returns the namespace URI this generator handles.
private org.jdom2.Namespace	getRDFNamespace()
private org.jdom2.Namespace	getTaxonomyNamespace()

Methods inherited from class java.lang.Object

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

Field Detail

DC_URI

private static final java.lang.String DC_URI

See Also:

Constant Field Values

TAXO_URI

private static final java.lang.String TAXO_URI

See Also:

Constant Field Values

RDF_URI

private static final java.lang.String RDF_URI

See Also:

Constant Field Values

DC_NS

private static final org.jdom2.Namespace DC_NS

TAXO_NS

private static final org.jdom2.Namespace TAXO_NS

RDF_NS

private static final org.jdom2.Namespace RDF_NS

NAMESPACES

private static final java.util.Set<org.jdom2.Namespace> NAMESPACES

Constructor Detail

DCModuleGenerator

public DCModuleGenerator()

Method Detail

getNamespaceUri

public final java.lang.String getNamespaceUri()

Description copied from interface: ModuleGenerator

Returns the namespace URI this generator handles.

Specified by:

getNamespaceUri in interface ModuleGenerator

Returns:

the namespace URI.

getDCNamespace

private final org.jdom2.Namespace getDCNamespace()

getRDFNamespace

private final org.jdom2.Namespace getRDFNamespace()

getTaxonomyNamespace

private final org.jdom2.Namespace getTaxonomyNamespace()

getNamespaces

public final java.util.Set<org.jdom2.Namespace> getNamespaces()

Returns a set with all the URIs (JDOM Namespace elements) this module generator uses.

It is used by the the feed generators to add their namespace definition in the root element of the generated document (forward-missing of Java 5.0 Generics).

Specified by:

getNamespaces in interface ModuleGenerator

Returns:

a set with all the URIs this module generator uses.

generate

public final void generate(Module module,
                           org.jdom2.Element element)

Populate an element tree with elements for a module.

Specified by:

generate in interface ModuleGenerator

Parameters:

module - the module to populate from.

element - the root element to attach child elements to.

generateSubjectElement

protected final org.jdom2.Element generateSubjectElement(DCSubject subject)

Utility method to generate an element for a subject.

Parameters:

subject - the subject to generate an element for.

Returns:

the element for the subject.

generateSimpleElement

protected final org.jdom2.Element generateSimpleElement(java.lang.String name,
                                                        java.lang.String value)

Utility method to generate a single element containing a string.

Parameters:

name - the name of the elment to generate.

value - the value of the text in the element.

Returns:

the element generated.

generateSimpleElementList

protected final java.util.List<org.jdom2.Element> generateSimpleElementList(java.lang.String name,
                                                                            java.util.List<java.lang.String> values)

Utility method to generate a list of simple elements.

Parameters:

name - the name of the element list to generate.

values - the list of values for the elements.

Returns:

a list of Elements created.