public abstract class TdbStructuredField extends TdbField
Modifier and Type | Method and Description |
---|---|
void |
appendValue(java.lang.String val)
Append a new subfield to the field.
|
void |
clear()
Clear the field's content; leaves the display form intact
|
int |
getFieldSize()
Retrieve the size of the value in the field.
|
java.lang.String |
getValue(int index)
Get the subfield value at the defined index.
|
int |
getValueCount()
Retrieve the count of the values in the field.
|
void |
insertValue(int index,
java.lang.String value)
Inserts a new subfield into the field.
|
java.util.List<java.lang.String> |
originalValues()
Retrieve a display form of the field's content -- see TdbField.getOriginalValues()
for more detail.
|
void |
removeValue(int index)
Removes a subfield from the field.
|
void |
setValue(int index,
java.lang.String val)
Set the defined subfield to the provided value.
|
java.lang.String |
toString()
Retrieves a simple newline-delimited version of the field's content, complete
with search term markup, if defined.
|
java.util.List<java.lang.String> |
values()
Retrieve the current content of the field -- see TdbField.getValues() for more
detail.
|
getName, getOwnerComponent, getType, isChanged
public java.util.List<java.lang.String> originalValues()
originalValues
in class TdbField
public java.util.List<java.lang.String> values()
public void clear()
public int getFieldSize()
getFieldSize
in class TdbField
TdbField.getFieldSize()
public java.lang.String getValue(int index) throws TdbException
getValue
in class TdbField
index
- Zero-based index of item to retrieveTdbException
public void setValue(int index, java.lang.String val) throws TdbException
setValue
in class TdbField
index
- Zero-based ndex of subfield to modify.val
- Value to assignTdbException
public void appendValue(java.lang.String val) throws TdbException
appendValue
in class TdbField
val
- The value to append to the fieldTdbException
public int getValueCount() throws TdbException
getValueCount
in class TdbField
TdbException
public void insertValue(int index, java.lang.String value) throws TdbException
insertValue
in class TdbField
index
- Zero-based index at which to insert the new subfield.value
- The value to insert into the field.TdbException
- If the index is out of bounds or the value is invalid.public void removeValue(int index) throws TdbException
removeValue
in class TdbField
index
- Zero-based index from which to remove a subfield.TdbException
- If the index is out of bounds.