Package stroom.docref

Class DocRef

java.lang.Object

stroom.docref.DocRef

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocRef>, HasDisplayValue

public class DocRef
extends java.lang.Object
implements java.lang.Comparable<DocRef>, HasDisplayValue, java.io.Serializable

"A class for describing a unique reference to a \'document\' in stroom. A \'document\' is an entity in stroom such as a data source dictionary or pipeline."

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocRef.Builder	Builder for constructing a docRef

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CLASS_DESC

Constructor Summary

Constructors

Constructor	Description
DocRef()	JAXB requires a no-arg constructor.
DocRef(java.lang.String type, java.lang.String uuid)
DocRef(java.lang.String type, java.lang.String uuid, java.lang.String name)

Method Summary

Modifier and Type	Method	Description
int	compareTo(DocRef o)
boolean	equals(java.lang.Object o)
java.lang.String	getDisplayValue()
java.lang.String	getName()
java.lang.String	getType()
java.lang.String	getUuid()
int	hashCode()
void	setName(java.lang.String name)
void	setType(java.lang.String type)
void	setUuid(java.lang.String uuid)
java.lang.String	toInfoString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_DESC

public static final java.lang.String CLASS_DESC

See Also:

Constant Field Values

Constructor Detail

DocRef

public DocRef()

JAXB requires a no-arg constructor.

DocRef

public DocRef(java.lang.String type,
              java.lang.String uuid)

Parameters:

type - The type of the 'document' that this docRef points to an instance of. Supported types are defined outside of this documentation.

uuid - A UUID as generated by UUID.randomUUID()

DocRef

public DocRef(java.lang.String type,
              java.lang.String uuid,
              java.lang.String name)

Parameters:

type - The type of the 'document' that this docRef points to an instance of. Supported types are defined outside of this documentation.

uuid - A UUID as generated by UUID.randomUUID()

name - The name of the 'document' being referenced

Method Detail

getType

public java.lang.String getType()

Returns:

The type of the 'document' that this docRef points to an instance of. Supported types are defined outside of this documentation.

setType

public void setType(java.lang.String type)

getUuid

public java.lang.String getUuid()

Returns:

A UUID as generated by UUID.randomUUID()

setUuid

public void setUuid(java.lang.String uuid)

getName

public java.lang.String getName()

Returns:

The name of the 'document' being referenced

setName

public void setName(java.lang.String name)

getDisplayValue

public java.lang.String getDisplayValue()

Specified by:

getDisplayValue in interface HasDisplayValue

Returns:

The string label/description of this object.

compareTo

public int compareTo(DocRef o)

Specified by:

compareTo in interface java.lang.Comparable<DocRef>

toInfoString

public java.lang.String toInfoString()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object