org.overlord.sramp.common

Class SrampModelUtils

java.lang.Object

org.overlord.sramp.common.SrampModelUtils

public class SrampModelUtils
extends Object

A collection of utilities for dealing with the s-ramp models.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
SrampModelUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static org.oasis_open.docs.s_ramp.ns.s_ramp_v1.Relationship	addGenericRelationship(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, String relationshipType, String targetUUID) Adds a new generic Relationship to the artifact.
static String	getCustomProperty(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, String propName) Gets the value of one of the s-ramp custom properties.
static org.oasis_open.docs.s_ramp.ns.s_ramp_v1.Relationship	getGenericRelationship(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, String relationshipType) Gets the generic relationship from the artifact (by type).
static boolean	isDocumentArtifact(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact) Returns true if the artifact is a Document style artifact (has content).
static boolean	isTextDocumentArtifact(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.DocumentArtifactType artifact) Returns true if the artifact has text content.
static void	setCustomProperty(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact, String propName, String propValue) Convenience method to help set a custom s-ramp property on the given artifact.

Methods inherited from class java.lang.Object

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

Constructor Detail

SrampModelUtils

public SrampModelUtils()

Method Detail

setCustomProperty

public static void setCustomProperty(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
                     String propName,
                     String propValue)

Convenience method to help set a custom s-ramp property on the given artifact.

Parameters:

artifact -

propName -

propValue -

getCustomProperty

public static String getCustomProperty(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
                       String propName)

Gets the value of one of the s-ramp custom properties.

Parameters:

artifact - the s-ramp artifact

propName - the name of the custom property

Returns:

the custom property value or null if not found

addGenericRelationship

public static org.oasis_open.docs.s_ramp.ns.s_ramp_v1.Relationship addGenericRelationship(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
                                                                          String relationshipType,
                                                                          String targetUUID)

Adds a new generic Relationship to the artifact.

Parameters:

artifact -

relationshipType -

targetUUID -

Returns:

the created Relationship

getGenericRelationship

public static org.oasis_open.docs.s_ramp.ns.s_ramp_v1.Relationship getGenericRelationship(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact,
                                                                          String relationshipType)

Gets the generic relationship from the artifact (by type).

Parameters:

artifact - the s-ramp artifact

relationshipType - the relationship type

Returns:

the Relationship or null if not found

isDocumentArtifact

public static boolean isDocumentArtifact(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.BaseArtifactType artifact)

Returns true if the artifact is a Document style artifact (has content).

Parameters:

artifact -

isTextDocumentArtifact

public static boolean isTextDocumentArtifact(org.oasis_open.docs.s_ramp.ns.s_ramp_v1.DocumentArtifactType artifact)

Returns true if the artifact has text content.

Parameters:

artifact -