com.merge.HL7.v240.fields
Class HL7FieldFN

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v240.fields.HL7FieldFN

public class HL7FieldFN
extends HL7Field

This data type allows full specification of the surname of a person. Where appropriate, it differentiates the person's own surname from that of the person's partner or spouse, in cases where the person's name may contain elements from either name. It also permits messages to distinguish the surname prefix (such as "van" or "de") from the surname root.

Nested Class Summary

Nested classes/interfaces inherited from class com.merge.HL7.HL7Field

HL7Field.FieldFormatter

Field Summary

Fields inherited from class com.merge.HL7.HL7Field

EMPTY_VALUE, NULL_VALUE

Constructor Summary

HL7FieldFN()
Creates an empty HL7 FN type field object.

Method Summary

java.lang.String	getComponentDescription(int index) Gets the description of a component in this field.
int	getComponentLength(int index) Gets the maximum number of characters for a component in this field.
java.lang.String	getComponentType(int index) Gets the HL7 data type of a component in this field.
int	getMaxSize() Gets the number of components defined for this field.
java.lang.String	getOwnSurname() Gets the Own Surname component of this field.
java.lang.String	getOwnSurnamePrefix() Gets the Own Surname Prefix component of this field.
java.lang.String	getSurname() Gets the Surname component of this field.
java.lang.String	getSurnameFromPartnerSpouse() Gets the Surname From Partner/Spouse component of this field.
java.lang.String	getSurnamePrefixFromPartnerSpouse() Gets the Surname Prefix From Partner/Spouse component of this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isOwnSurnameEmpty() Tells whether the Own Surname component has been specified.
boolean	isOwnSurnameNull() Tells whether the Own Surname component has a has Null value as defined by HL7.
boolean	isOwnSurnamePrefixEmpty() Tells whether the Own Surname Prefix component has been specified.
boolean	isOwnSurnamePrefixNull() Tells whether the Own Surname Prefix component has a has Null value as defined by HL7.
boolean	isSurnameEmpty() Tells whether the Surname component has been specified.
boolean	isSurnameFromPartnerSpouseEmpty() Tells whether the Surname From Partner/Spouse component has been specified.
boolean	isSurnameFromPartnerSpouseNull() Tells whether the Surname From Partner/Spouse component has a has Null value as defined by HL7.
boolean	isSurnameNull() Tells whether the Surname component has a has Null value as defined by HL7.
boolean	isSurnamePrefixFromPartnerSpouseEmpty() Tells whether the Surname Prefix From Partner/Spouse component has been specified.
boolean	isSurnamePrefixFromPartnerSpouseNull() Tells whether the Surname Prefix From Partner/Spouse component has a has Null value as defined by HL7.
void	setOwnSurname(java.lang.String val) Sets the Own Surname from a string.
void	setOwnSurnamePrefix(java.lang.String val) Sets the Own Surname Prefix from a string.
void	setSurname(java.lang.String val) Sets the Surname from a string.
void	setSurnameFromPartnerSpouse(java.lang.String val) Sets the Surname From Partner/Spouse from a string.
void	setSurnamePrefixFromPartnerSpouse(java.lang.String val) Sets the Surname Prefix From Partner/Spouse from a string.

Methods inherited from class com.merge.HL7.HL7Field

clone, createField, createField, getBoolValue, getComponent, getContent, getContent, getContent, getDataType, getDateValue, getDoubleValue, getFieldFormatter, getFieldName, getHL7Version, getIntValue, getMinSize, getValue, getValue, isBasicType, isEmpty, isNull, setComponent, setContent, setContent, setFieldClass, setFormatter, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, size, toAnnotatedString, toAnnotatedString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HL7FieldFN

public HL7FieldFN()

Creates an empty HL7 FN type field object.

Method Detail

getMaxSize

public int getMaxSize()

Gets the number of components defined for this field.

Overrides:

getMaxSize in class HL7Field

Returns:

The maximum number of components.

getComponentType

public java.lang.String getComponentType(int index)

Gets the HL7 data type of a component in this field.

Overrides:

getComponentType in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's data type.

getComponentDescription

public java.lang.String getComponentDescription(int index)

Gets the description of a component in this field.

Overrides:

getComponentDescription in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's description.

getComponentLength

public int getComponentLength(int index)

Gets the maximum number of characters for a component in this field.

Overrides:

getComponentLength in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

The maximum length of the component as defined by HL7.

isComponentMandatory

public boolean isComponentMandatory(int index)

Tells whether a component is mandatory.

Overrides:

isComponentMandatory in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

true if the specified component is mandatory.

getTableNo

public java.lang.String getTableNo(int index)

Gets the table identifier of a component in this field.

Overrides:

getTableNo in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the table number as defined by HL7 or an empty string if a table number is not defined.

getSurname

public java.lang.String getSurname()

Gets the Surname component of this field.

Returns:

the Surname value

setSurname

public void setSurname(java.lang.String val)

Sets the Surname from a string.

Parameters:

val - The value to set for Surname

isSurnameEmpty

public boolean isSurnameEmpty()

Tells whether the Surname component has been specified.

Returns:

true if the component is empty.

isSurnameNull

public boolean isSurnameNull()

Tells whether the Surname component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getOwnSurnamePrefix

public java.lang.String getOwnSurnamePrefix()

Gets the Own Surname Prefix component of this field.

Returns:

the Own Surname Prefix value

setOwnSurnamePrefix

public void setOwnSurnamePrefix(java.lang.String val)

Sets the Own Surname Prefix from a string.

Parameters:

val - The value to set for Own Surname Prefix

isOwnSurnamePrefixEmpty

public boolean isOwnSurnamePrefixEmpty()

Tells whether the Own Surname Prefix component has been specified.

Returns:

true if the component is empty.

isOwnSurnamePrefixNull

public boolean isOwnSurnamePrefixNull()

Tells whether the Own Surname Prefix component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getOwnSurname

public java.lang.String getOwnSurname()

Gets the Own Surname component of this field.

Returns:

the Own Surname value

setOwnSurname

public void setOwnSurname(java.lang.String val)

Sets the Own Surname from a string.

Parameters:

val - The value to set for Own Surname

isOwnSurnameEmpty

public boolean isOwnSurnameEmpty()

Tells whether the Own Surname component has been specified.

Returns:

true if the component is empty.

isOwnSurnameNull

public boolean isOwnSurnameNull()

Tells whether the Own Surname component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getSurnamePrefixFromPartnerSpouse

public java.lang.String getSurnamePrefixFromPartnerSpouse()

Gets the Surname Prefix From Partner/Spouse component of this field.

Returns:

the Surname Prefix From Partner/Spouse value

setSurnamePrefixFromPartnerSpouse

public void setSurnamePrefixFromPartnerSpouse(java.lang.String val)

Sets the Surname Prefix From Partner/Spouse from a string.

Parameters:

val - The value to set for Surname Prefix From Partner/Spouse

isSurnamePrefixFromPartnerSpouseEmpty

public boolean isSurnamePrefixFromPartnerSpouseEmpty()

Tells whether the Surname Prefix From Partner/Spouse component has been specified.

Returns:

true if the component is empty.

isSurnamePrefixFromPartnerSpouseNull

public boolean isSurnamePrefixFromPartnerSpouseNull()

Tells whether the Surname Prefix From Partner/Spouse component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getSurnameFromPartnerSpouse

public java.lang.String getSurnameFromPartnerSpouse()

Gets the Surname From Partner/Spouse component of this field.

Returns:

the Surname From Partner/Spouse value

setSurnameFromPartnerSpouse

public void setSurnameFromPartnerSpouse(java.lang.String val)

Sets the Surname From Partner/Spouse from a string.

Parameters:

val - The value to set for Surname From Partner/Spouse

isSurnameFromPartnerSpouseEmpty

public boolean isSurnameFromPartnerSpouseEmpty()

Tells whether the Surname From Partner/Spouse component has been specified.

Returns:

true if the component is empty.

isSurnameFromPartnerSpouseNull

public boolean isSurnameFromPartnerSpouseNull()

Tells whether the Surname From Partner/Spouse component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.