com.rometools.modules.opensearch.impl

Class OpenSearchModuleGenerator

java.lang.Object

com.rometools.modules.opensearch.impl.OpenSearchModuleGenerator

All Implemented Interfaces:

ModuleGenerator

public class OpenSearchModuleGenerator
extends java.lang.Object
implements ModuleGenerator

Constructor Summary

Constructors

Constructor and Description
OpenSearchModuleGenerator()

Method Summary

Modifier and Type	Method and Description
void	generate(Module module, org.jdom2.Element element) Generates and injects module metadata into an XML node (JDOM element).
protected org.jdom2.Element	generateLinkElement(Link link)
protected org.jdom2.Element	generateQueryElement(OSQuery query)
protected org.jdom2.Element	generateSimpleElement(java.lang.String name, java.lang.String value)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSearchModuleGenerator

public OpenSearchModuleGenerator()

Method Detail

getNamespaceUri

public 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.

getNamespaces

public 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 (JDOM Namespace elements) this module generator uses.

generate

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

Description copied from interface: ModuleGenerator

Generates and injects module metadata into an XML node (JDOM element).

Specified by:

generate in interface ModuleGenerator

Parameters:

module - the module to inject into the XML node (JDOM element).

element - the XML node into which module meta-data will be injected.

generateQueryElement

protected org.jdom2.Element generateQueryElement(OSQuery query)

generateLinkElement

protected org.jdom2.Element generateLinkElement(Link link)

generateSimpleElement

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