org.dcm4che.data
Interface PersonName


public interface PersonName

Version:
1.0.0
Author:
gunter.zeilinger@tiani.com

Field Summary
static int FAMILY
          Field number for get and set indicating the family name complex
static int GIVEN
          Field number for get and set indicating the given name complex
static int MIDDLE
          Field number for get and set indicating the middle name
static int PREFIX
          Field number for get and set indicating the name prefix
static int SUFFIX
          Field number for get and set indicating the name suffix
 
Method Summary
 java.lang.String format()
           
 java.lang.String format(int[] fields)
           
 java.lang.String get(int field)
          Gets the value for a given name field.
 PersonName getIdeographic()
          Returns ideographic representation.
 PersonName getPhonetic()
          Returns phonetic representation.
 void set(int field, java.lang.String value)
          Sets the name field with the given value.
 void setIdeographic(PersonName ideographic)
          Sets ideographic representation.
 void setPhonetic(PersonName phonetic)
          Sets phonetic representation.
 java.lang.String toComponentGroupMatch()
           
 java.lang.String toComponentGroupString(boolean trim)
           
 java.lang.String toString()
           
 

Field Detail

FAMILY

static final int FAMILY
Field number for get and set indicating the family name complex

See Also:
Constant Field Values

GIVEN

static final int GIVEN
Field number for get and set indicating the given name complex

See Also:
Constant Field Values

MIDDLE

static final int MIDDLE
Field number for get and set indicating the middle name

See Also:
Constant Field Values

PREFIX

static final int PREFIX
Field number for get and set indicating the name prefix

See Also:
Constant Field Values

SUFFIX

static final int SUFFIX
Field number for get and set indicating the name suffix

See Also:
Constant Field Values
Method Detail

get

java.lang.String get(int field)
Gets the value for a given name field.

Parameters:
field - the given name field.
Returns:
the value for the given name field

set

void set(int field,
         java.lang.String value)
Sets the name field with the given value.

Parameters:
field - the given name field.
value - the value to be set for the given name field.

getIdeographic

PersonName getIdeographic()
Returns ideographic representation.

Returns:
ideographic representation

getPhonetic

PersonName getPhonetic()
Returns phonetic representation.

Returns:
phonetic representation

setIdeographic

void setIdeographic(PersonName ideographic)
Sets ideographic representation.

Parameters:
the - ideographic representation to be set

setPhonetic

void setPhonetic(PersonName phonetic)
Sets phonetic representation.

Parameters:
the - phonetic representation to be set

toString

java.lang.String toString()
Overrides:
toString in class java.lang.Object

toComponentGroupString

java.lang.String toComponentGroupString(boolean trim)

toComponentGroupMatch

java.lang.String toComponentGroupMatch()

format

java.lang.String format()

format

java.lang.String format(int[] fields)