Package com.caplin.datasource.interfaces
Interface DSField
-
public interface DSField
This interface should be implemented by a class that represents a field number/value pair. The field number defines what data the field represents (e.g. a bid price, or a company name). The value is the actual value for that data (e.g. 53.5, or Caplin Systems Ltd).
- See Also:
DSData.elements()
,DSData.iterator()
-
-
Field Summary
Fields Modifier and Type Field Description static int
F_CONTAINER_INSERT_AT
Flag used internally to identify that the DSField represents an object to be inserted in a container (byDSContainer.insertObject(java.lang.String, int)
).static int
MAX_FLAG_VALUE
The maximum value permissible for the OR of all the flags on a DSField.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FieldInfo
getFieldInfo()
Get the field information for this field, if available.int
getFlags()
Get the flags set on this field.java.lang.String
getValue()
Gets the value for the field.void
setFieldInfo(FieldInfo fieldInfo)
Sets the field information for the field.void
setValue(java.lang.String value)
Sets the value for the field.
-
-
-
Field Detail
-
MAX_FLAG_VALUE
static final int MAX_FLAG_VALUE
The maximum value permissible for the OR of all the flags on a DSField.- See Also:
- Constant Field Values
-
F_CONTAINER_INSERT_AT
static final int F_CONTAINER_INSERT_AT
Flag used internally to identify that the DSField represents an object to be inserted in a container (byDSContainer.insertObject(java.lang.String, int)
). This flag is used solely by implementations ofDSContainer
.- See Also:
- Constant Field Values
-
-
Method Detail
-
getValue
java.lang.String getValue()
Gets the value for the field.
- Returns:
- The field's value.
-
setValue
void setValue(java.lang.String value)
Sets the value for the field.
- Parameters:
value
- The new field value.
-
getFieldInfo
FieldInfo getFieldInfo()
Get the field information for this field, if available.
- Returns:
- the
FieldInfo
for this field, or null if not available
-
setFieldInfo
void setFieldInfo(FieldInfo fieldInfo)
Sets the field information for the field.
- Parameters:
fieldInfo
- The new FieldInfo for this field.
-
getFlags
int getFlags()
Get the flags set on this field.- Returns:
- the flags set on this field
-
-