au.gov.nehta.vendorlibrary.mdm.datatypes
Class HD

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.mdm.datatypes.HD

public final class HD
extends java.lang.Object

HD Encapsulates an HL7 V2 hierarchic designator HD identifier.


Nested Class Summary
static class HD.Builder
          HD.Builder Build class used to construct and validate an HD object.
 
Method Summary
 java.lang.String getIdentifier()
          Retrieve universal identifier.
 java.lang.String getIdentifierType()
          Retrieve universal identifier type.
 java.lang.String getNamespace()
          Retrieve namespace.
static HD parse(java.lang.String parseValue)
          Parse HD from string.
 java.lang.String toString()
          Outputs an HD in the following format:

namespace^identifier^identifierType

Variables that are not set are denoted by an empty string.

 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getNamespace

public java.lang.String getNamespace()
Retrieve namespace.

Returns:
Namespace.

getIdentifier

public java.lang.String getIdentifier()
Retrieve universal identifier.

Returns:
Identifier.

getIdentifierType

public java.lang.String getIdentifierType()
Retrieve universal identifier type.

Returns:
Identifier type.

parse

public static HD parse(java.lang.String parseValue)
Parse HD from string.

Parameters:
parseValue - String to be parsed (not null).
Returns:
HD

toString

public java.lang.String toString()
Outputs an HD in the following format:

namespace^identifier^identifierType

Variables that are not set are denoted by an empty string.

Trailing '^' symbols are trimmed. For example:

'namespace^^' becomes 'namespace'

Overrides:
toString in class java.lang.Object
Returns:
Formatted string.