Package io.openmanufacturing.sds.aspectmodel.urn

Class AspectModelUrn

java.lang.Object

io.openmanufacturing.sds.aspectmodel.urn.AspectModelUrn

public class AspectModelUrn
extends Object

Represents the identifier URN of an Aspect Model.

See Also:

https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/v1.0.0/namespaces.html for the definition of the URN.

Field Summary

Fields

Modifier and Type	Field	Description
static int	ASPECT_NAME_INDEX
static int	MAX_URN_LENGTH
static String	MODEL_ELEMENT_NAME_REGEX
static Pattern	NAMESPACE_PATTERN
static String	NAMESPACE_REGEX
static String	VALID_NAMESPACE_IDENTIFIER
static String	VALID_PROTOCOL
static String	VERSION_REGEX

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static AspectModelUrn	fromUrn(String urn)	Creates a AspectModelUrn from a URN.
static AspectModelUrn	fromUrn(URI urn)	Creates a AspectModelUrn from a URN.
ElementType	getElementType()
String	getName()	Returns the local name of the model element, e.g.
String	getNamespace()	Returns the namespace part of the URN, e.g.
URI	getUrn()	Returns the full URN of the model element
String	getUrnPrefix()	Returns prefix part of the URN, i.e.
String	getVersion()	Returns the version of the model element, e.g.
int	hashCode()
boolean	isBammUrn()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAMESPACE_REGEX

public static final String NAMESPACE_REGEX

See Also:

Constant Field Values

NAMESPACE_PATTERN

public static final Pattern NAMESPACE_PATTERN

MODEL_ELEMENT_NAME_REGEX

public static final String MODEL_ELEMENT_NAME_REGEX

See Also:

Constant Field Values

VERSION_REGEX

public static final String VERSION_REGEX

See Also:

Constant Field Values

VALID_PROTOCOL

public static final String VALID_PROTOCOL

See Also:

Constant Field Values

VALID_NAMESPACE_IDENTIFIER

public static final String VALID_NAMESPACE_IDENTIFIER

See Also:

Constant Field Values

MAX_URN_LENGTH

public static final int MAX_URN_LENGTH

See Also:

Constant Field Values

ASPECT_NAME_INDEX

public static final int ASPECT_NAME_INDEX

See Also:

Constant Field Values

Method Detail

fromUrn

public static AspectModelUrn fromUrn(String urn)

Creates a AspectModelUrn from a URN.

Parameters:

urn - the urn which will be parsed to create the AspectModelUrn instance

Returns:

AspectModelUrn containing the individual parts from the urn

Throws:

UrnSyntaxException - if urn is not valid

fromUrn

public static AspectModelUrn fromUrn(URI urn)

Creates a AspectModelUrn from a URN.

Parameters:

urn - the urn which will be parsed to create the AspectModelUrn instance

Returns:

AspectModelUrn containing the individual parts from the urn

Throws:

UrnSyntaxException - if urn is not valid

getUrn

public URI getUrn()

Returns the full URN of the model element

Returns:

the model URN

getName

public String getName()

Returns the local name of the model element, e.g. MyAspect

Returns:

the local name of the model element

getVersion

public String getVersion()

Returns the version of the model element, e.g. 1.2.3

Returns:

the version of the model element

getNamespace

public String getNamespace()

Returns the namespace part of the URN, e.g. com.example.foo

Returns:

the namespace part of the URN

getUrnPrefix

public String getUrnPrefix()

Returns prefix part of the URN, i.e. the part up to and including the # but not including the local name, e.g. urn:bamm:com.foo.example:1.0.0#

Returns:

the prefix part of the URN

getElementType

public ElementType getElementType()

isBammUrn

public boolean isBammUrn()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object