public class SchemeField extends BaseSchemeFieldElement
Modifier and Type | Field and Description |
---|---|
protected SchemeFieldDefaultValue |
defaultValue |
protected int |
index
Position index of the field in its containing scheme (starting at 1).
Index does not actually need to be set externally, but hiding this from client classes is rather complex. |
NO_LETTER
editable, maxRepetitions, minRepetitions, name, UNLIMITED, visible
Constructor and Description |
---|
SchemeField() |
SchemeField(java.lang.String id,
int index) |
SchemeField(java.lang.String id,
java.lang.Integer minRepetitions,
java.lang.Integer maxRepetitions,
int index) |
SchemeField(java.lang.String name,
java.lang.Integer minRepetitions,
java.lang.Integer maxRepetitions,
java.util.List<java.lang.String> letterOptions,
int index) |
SchemeField(java.lang.String id,
java.lang.Integer minRepetitions,
java.lang.Integer maxRepetitions,
java.lang.String letterOptions,
int index) |
SchemeField(java.lang.String id,
java.util.List<java.lang.String> letterOptions,
int index) |
SchemeField(java.lang.String id,
java.lang.String letterOptions,
int index) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
SchemeFieldDefaultValue |
getDefaultValue() |
int |
getIndex() |
int |
getLetterOptionsCount()
Get the size of the letter options list or zero if such list is
null |
java.util.List<SchemeFieldQualifier> |
getQualifiers() |
java.util.List<SchemeFieldQualifier> |
getQualifiers(java.lang.String letterOption)
Gets the qualifiers for a particular letter option.
|
java.util.List<SchemeFieldQualifier> |
getQualifiers(java.lang.String letterOption,
int component)
Gets the qualifiers for a particular letter option and component number.
|
protected SchemeFieldQualifier |
getSchemeFieldQualifierFromToken(java.lang.String token)
Parses a token and creates the qualifier object.
The token may be a single literal, with a letter prefix, or with a letter+component prefix. |
int |
hashCode() |
void |
setDefaultValue(SchemeFieldDefaultValue defaultValue) |
void |
setIndex(int index) |
void |
setQualifiers(java.util.List<SchemeFieldQualifier> qualifiers) |
void |
setQualifiers(java.lang.String qualifiers)
This method parses the String argument conforming a list with each individual qualifier
found in the String.
|
java.lang.String |
toString() |
addEval, getEvals, getLetterOptions, getLetterOptionsString, getNumber, getRules, getRulesAsList, getTagNames, isLetter, setEvals, setLetterOptions, setLetterOptions, setLetterOptionsString, setRules
asField, asFieldSet, getDescription, getId, getMaxRepetitions, getMinRepetitions, getName, isEditable, isField, isFieldSet, isMandatory, isOptional, isRepetitive, isSequence, isUnlimited, isVisible, setDescription, setEditable, setId, setMaxRepetitions, setMinRepetitions, setName, setVisible
protected SchemeFieldDefaultValue defaultValue
protected int index
public SchemeField()
public SchemeField(java.lang.String id, int index)
public SchemeField(java.lang.String id, java.lang.Integer minRepetitions, java.lang.Integer maxRepetitions, int index)
public SchemeField(java.lang.String name, java.lang.Integer minRepetitions, java.lang.Integer maxRepetitions, java.util.List<java.lang.String> letterOptions, int index)
public SchemeField(java.lang.String id, java.lang.Integer minRepetitions, java.lang.Integer maxRepetitions, java.lang.String letterOptions, int index)
public SchemeField(java.lang.String id, java.util.List<java.lang.String> letterOptions, int index)
public SchemeField(java.lang.String id, java.lang.String letterOptions, int index)
public boolean equals(java.lang.Object obj)
equals
in class BaseSchemeFieldElement
public SchemeFieldDefaultValue getDefaultValue()
public int getIndex()
public int getLetterOptionsCount()
null
public java.util.List<SchemeFieldQualifier> getQualifiers()
public java.util.List<SchemeFieldQualifier> getQualifiers(java.lang.String letterOption)
String
- a particular letter option, if null
it returns all qualifierspublic java.util.List<SchemeFieldQualifier> getQualifiers(java.lang.String letterOption, int component)
getQualifiers(String)
protected SchemeFieldQualifier getSchemeFieldQualifierFromToken(java.lang.String token)
token
- public int hashCode()
hashCode
in class BaseSchemeFieldElement
public void setDefaultValue(SchemeFieldDefaultValue defaultValue)
public void setIndex(int index)
index
- the position of the field relative to the schemepublic void setQualifiers(java.util.List<SchemeFieldQualifier> qualifiers)
public void setQualifiers(java.lang.String qualifiers)
qualifiers
- the qualifiers to set in a String with the comma separated letterspublic java.lang.String toString()
toString
in class BaseSchemeFieldElement