org.overlord.sramp.atom.visitors

Class ArtifactToSummaryAtomEntryVisitor

java.lang.Object

org.overlord.sramp.common.visitors.ArtifactVisitorAdapter

org.overlord.sramp.atom.visitors.ArtifactToSummaryAtomEntryVisitor

All Implemented Interfaces:

ArtifactVisitor

Direct Known Subclasses:

ArtifactToFullAtomEntryVisitor

public class ArtifactToSummaryAtomEntryVisitor
extends ArtifactVisitorAdapter

Visitor used to convert an artifact to an Atom entry.

Author:

eric.wittmann@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jboss.resteasy.plugins.providers.atom.Entry	atomEntry
protected String	baseUrl
protected Exception	failure
protected Set<String>	propertyNames

Constructor Summary

Constructors

Constructor and Description
ArtifactToSummaryAtomEntryVisitor(String baseUrl) Constructor.
ArtifactToSummaryAtomEntryVisitor(String baseUrl, Set<String> propNames) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected BaseArtifactType	createIncludedArtifact(BaseArtifactType artifact) Creates the artifact that should be included in the returned Entry.
org.jboss.resteasy.plugins.providers.atom.Entry	getAtomEntry()
protected boolean	includeArtifact() Returns true if we should include the Artifact wrapper in the Entry.
void	reset() Called to reset the created entry and failure Exception.
protected void	setAtomEntry(org.jboss.resteasy.plugins.providers.atom.Entry entry) Sets the Atom entry.
void	visit(ExtendedArtifactType artifact)
void	visit(ExtendedDocument artifact)
protected void	visitBase(BaseArtifactType artifact) Creates the base Atom Entry, doing the stuff that's common to all types of artifacts.

Methods inherited from class org.overlord.sramp.common.visitors.ArtifactVisitorAdapter

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class java.lang.Object

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

Field Detail

baseUrl

protected String baseUrl

atomEntry

protected org.jboss.resteasy.plugins.providers.atom.Entry atomEntry

failure

protected Exception failure

propertyNames

protected Set<String> propertyNames

Constructor Detail

ArtifactToSummaryAtomEntryVisitor

public ArtifactToSummaryAtomEntryVisitor(String baseUrl)

Constructor.

Parameters:

baseUrl -

ArtifactToSummaryAtomEntryVisitor

public ArtifactToSummaryAtomEntryVisitor(String baseUrl,
                                 Set<String> propNames)

Constructor.

Parameters:

baseUrl -

propNames -

Method Detail

reset

public void reset()

Called to reset the created entry and failure Exception. Call this between visits of different artifacts - useful if you want to re-use the visitor in a loop.

getAtomEntry

public org.jboss.resteasy.plugins.providers.atom.Entry getAtomEntry()
                                                             throws Exception

Returns:

the atomEntry

Throws:

Exception

setAtomEntry

protected void setAtomEntry(org.jboss.resteasy.plugins.providers.atom.Entry entry)

Sets the Atom entry.

Parameters:

entry - an Atom Entry

visitBase

protected void visitBase(BaseArtifactType artifact)

Creates the base Atom Entry, doing the stuff that's common to all types of artifacts.

Overrides:

visitBase in class ArtifactVisitorAdapter

See Also:

ArtifactVisitorAdapter.visitBase(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType)

visit

public void visit(ExtendedArtifactType artifact)

Specified by:

visit in interface ArtifactVisitor

Overrides:

visit in class ArtifactVisitorAdapter

See Also:

ArtifactVisitorAdapter.visit(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.ExtendedArtifactType)

visit

public void visit(ExtendedDocument artifact)

Specified by:

visit in interface ArtifactVisitor

Overrides:

visit in class ArtifactVisitorAdapter

See Also:

ArtifactVisitor.visit(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.ExtendedDocument)

includeArtifact

protected boolean includeArtifact()

Returns true if we should include the Artifact wrapper in the Entry. For the summary Entry we would include the artifact wrapper only if we're returning some additional custom properties.

createIncludedArtifact

protected BaseArtifactType createIncludedArtifact(BaseArtifactType artifact)
                                           throws InstantiationException,
                                                  IllegalAccessException

Creates the artifact that should be included in the returned Entry.

Throws:

IllegalAccessException

InstantiationException