public abstract class TdbField
extends java.lang.Object
implements com.tietoenator.trip.jxp.internal.utils.DOMSink
Modifier and Type | Method and Description |
---|---|
abstract void |
appendValue(java.lang.String val)
Append a new subfield or paragraph to the field
|
abstract void |
appendValues(java.util.Collection<java.lang.String> val)
Append several new subfields or paragraphs to the field
|
abstract void |
clear()
Clear any existing content from the field
|
abstract int |
getFieldSize()
Retrieve the size of the value in the field.
|
java.lang.String |
getName()
Get the name of the field
|
TdbComponent |
getOwnerComponent()
Get a reference to the component within which this field exists
|
abstract TdbFieldType |
getType()
Get the TRIP field type of the field
|
abstract java.lang.String |
getValue(int index)
Get the subfield or paragraph value at the defined index
|
abstract int |
getValueCount()
Retrieve the count of the values in the field.
|
abstract void |
insertValue(int index,
java.lang.String value)
Inserts a new subfield or paragraph into the field.
|
abstract void |
insertValues(int index,
java.util.Collection<java.lang.String> values)
Inserts several new subfields or paragraphs into the field.
|
boolean |
isChanged()
Returns the change status for the field.
|
abstract boolean |
isPartial()
Returns true if this field contains a partial value.
|
abstract java.util.List<java.lang.String> |
originalValues()
Retrieve the display content of the field.
|
abstract void |
removeValue(int index)
Removes a subfield or paragraph from the field.
|
abstract void |
setValue(int index,
java.lang.String val)
Set the defined subfield or paragraph to the provided value
Note that the index provided must lie within the current bounds of the field. |
abstract java.lang.String |
toString()
Override the system-default behavior to provide a string representation of the
field.
|
abstract java.util.List<java.lang.String> |
values()
Retrieve the current content of the field.
|
public java.lang.String getName()
public boolean isChanged()
public abstract TdbFieldType getType()
public abstract java.util.List<java.lang.String> originalValues() throws TdbException
TdbException
public abstract java.util.List<java.lang.String> values() throws TdbException
TdbException
public TdbComponent getOwnerComponent()
public abstract void clear()
public abstract java.lang.String getValue(int index) throws TdbException
index
- Zero-based index of item to retrieveTdbException
public abstract int getFieldSize()
The use of this property is only valid when connected to TRIPsystem version 6.2-0 or later.
The value returned by this property is the total size of all subfields or paragraphs in the field. For STRING fields, this is simply the total size of the binary data stored in the field.
This property reflects any updates made to the field since retrieval.
public abstract boolean isPartial()
Partial values are typically produced when requesting a hit-focused so-called "teaser" value from a TEXT or PHRASE field. E.g. for display in result lists.
For STRING fields, the semantics of the Partial property is slightly different. For a TdbStringField to be considered partial, it must have been fetched with a field template assigned the TdbFieldFetchType.NoValue option.
Partial values should be considered read-only, even if the current user has write access to the field. Writing back a partial value will overwrite the existing full value, causing what amounts to data corruption.
public abstract void setValue(int index, java.lang.String val) throws TdbException
index
- Zero-based index of subfield or paragraph to modifyval
- Value to assignTdbException
public abstract void appendValue(java.lang.String val) throws TdbException
val
- The value to append to the fieldTdbException
public abstract void appendValues(java.util.Collection<java.lang.String> val) throws TdbException
val
- The values to append to the fieldTdbException
public abstract void insertValue(int index, java.lang.String value) throws TdbException
index
- Zero-based index at which to insert the new subfield or paragraph.value
- The value to insert into the field.TdbException
public abstract void insertValues(int index, java.util.Collection<java.lang.String> values) throws TdbException
index
- Zero-based index at which to insert the new subfields or paragraphs.values
- The value to insert into the field.TdbException
public abstract void removeValue(int index) throws TdbException
index
- Zero-based index from which to remove a subfield or paragraph.TdbException
public abstract int getValueCount() throws TdbException
TdbException
public abstract java.lang.String toString()
toString
in class java.lang.Object