org.overlord.sramp.common.derived

Interface ArtifactDeriver

All Known Implementing Classes:

AbstractXmlDeriver, PolicyDeriver, WsdlDeriver, XsdDeriver

public interface ArtifactDeriver

Provides a way to derive artifacts. Classes that implement this interface must be able to parse a particular type of artifact and produce all of the derived artifacts for it. Examples include an XSD deriver, WSDL deriver, etc.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
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 contentStream) Given an artifact, this method will return a collection of derived content for it.
void	link(LinkerContext context, org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType sourceArtifact, Collection<org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType> derivedArtifacts) This method represents the "linker" phase of deriving artifact content.

Method Detail

derive

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 contentStream)
                                                                            throws IOException

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

Parameters:

artifact - the artifact to derive

contentStream - the artifact content

Returns:

derived content

Throws:

IOException

link

void link(LinkerContext context,
        org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType sourceArtifact,
        Collection<org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType> derivedArtifacts)

This method represents the "linker" phase of deriving artifact content. The linker phase is responsible for creating any relationships between and among the derived artifacts.

Parameters:

context -

sourceArtifact -

derivedArtifacts -