org.overlord.sramp.common.derived

Class AbstractXmlDeriver

java.lang.Object

org.overlord.sramp.common.derived.AbstractXmlDeriver

All Implemented Interfaces:

ArtifactDeriver

Direct Known Subclasses:

PolicyDeriver, XsdDeriver

public abstract class AbstractXmlDeriver
extends Object
implements ArtifactDeriver

Base class for all derivers that are based on XML documents. This base class does some of the boilerplate such as parsing the document. Child classes are responsible for processing the resulting document in interesting ways.

Author:

eric.wittmann@redhat.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractXmlDeriver.XmlDeriverContext A context passed to the xml deriver's derive method.

Constructor Summary

Constructors

Constructor and Description
AbstractXmlDeriver() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureNamespaceMappings(StaticNamespaceContext namespaceContext) Configures the namespace mappings that will be available when executing XPath queries.
protected Collection<org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType>	createDerivedArtifactCollection() Sub-classes could provide an alternate collection here.
Collection<org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType>	derive(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, InputStream content) Given an artifact, this method will return a collection of derived content for it.
protected abstract void	derive(Collection<org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType> derivedArtifacts, org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, AbstractXmlDeriver.XmlDeriverContext xmlDeriverContext) Derives content for the given artifact.
protected Object	query(XPath xpath, Element context, String query, QName returnType) Performs an x-query against the given context node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.overlord.sramp.common.derived.ArtifactDeriver

link

Constructor Detail

AbstractXmlDeriver

public AbstractXmlDeriver()

Constructor.

Method Detail

derive

public Collection<org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType> derive(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
                                                                          InputStream content)
                                                                            throws IOException

Description copied from interface: ArtifactDeriver

Given an artifact, this method will return a collection of derived content for it.

Specified by:

derive in interface ArtifactDeriver

Parameters:

artifact - the artifact to derive

content - the artifact content

Returns:

derived content

Throws:

IOException

See Also:

org.overlord.sramp.common.repository.derived.ArtifactDeriver#derive(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType, java.io.InputStream)

createDerivedArtifactCollection

protected Collection<org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType> createDerivedArtifactCollection()

Sub-classes could provide an alternate collection here. For example, the WsdlDeriver creates an indexed artifact collection so that it can reference derived artifacts and make connections/relationships.

query

protected Object query(XPath xpath,
           Element context,
           String query,
           QName returnType)
                throws XPathExpressionException

Performs an x-query against the given context node.

Parameters:

xpath -

query -

returnType -

Throws:

XPathExpressionException

derive

protected abstract void derive(Collection<org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType> derivedArtifacts,
          org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
          AbstractXmlDeriver.XmlDeriverContext xmlDeriverContext)
                        throws IOException

Derives content for the given artifact.

Parameters:

derivedArtifacts -

artifact -

xmlDeriverContext -

Throws:

IOException

configureNamespaceMappings

protected void configureNamespaceMappings(StaticNamespaceContext namespaceContext)

Configures the namespace mappings that will be available when executing XPath queries.

Parameters:

namespaceContext -