com.prowidesoftware.swift.scheme

Class BaseSchemeFieldElement

java.lang.Object

com.prowidesoftware.swift.scheme.BaseSchemeElement

com.prowidesoftware.swift.scheme.BaseSchemeFieldElement

Direct Known Subclasses:

SchemeField, SchemeFieldSet

public class BaseSchemeFieldElement
extends BaseSchemeElement

Base class for field related scheme elements.

Author:

www.prowidesoftware.com

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NO_LETTER

Fields inherited from class com.prowidesoftware.swift.scheme.BaseSchemeElement

editable, maxRepetitions, minRepetitions, name, UNLIMITED, visible

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseSchemeFieldElement()
protected	BaseSchemeFieldElement(java.lang.String name)
protected	BaseSchemeFieldElement(java.lang.String name, java.lang.Integer minRepetitions, java.lang.Integer maxRepetitions)
protected	BaseSchemeFieldElement(java.lang.String name, java.lang.Integer minRepetitions, java.lang.Integer maxRepetitions, java.util.List<java.lang.String> letterOptions)
protected	BaseSchemeFieldElement(java.lang.String name, java.lang.Integer minRepetitions, java.lang.Integer maxRepetitions, java.lang.String letterOptions)
protected	BaseSchemeFieldElement(java.lang.String name, java.util.List<java.lang.String> letterOptions)
protected	BaseSchemeFieldElement(java.lang.String name, java.lang.String letterOptions)

Method Summary

Methods

Modifier and Type	Method and Description
void	addEval(SchemeEval eval)
boolean	equals(java.lang.Object obj)
java.util.List<SchemeEval>	getEvals()
java.util.List<java.lang.String>	getLetterOptions()
java.lang.String	getLetterOptionsString()
int	getNumber() Returns the field id converted to a number.
java.lang.String	getRules()
java.util.List<java.lang.String>	getRulesAsList()
java.util.List<java.lang.String>	getTagNames() Returns the list of tag names that this field supports, concatenating the field number with the letter options; and considering the NO_LETTER option as well.
int	hashCode()
boolean	isLetter(java.lang.String letter) Returns true if the field has only one letter option and the letter is equals to the parameter letter
void	setEvals(java.util.List<SchemeEval> evals)
void	setLetterOptions(java.util.List<java.lang.String> letterOptions)
void	setLetterOptions(java.lang.String letterOptions) This method parses the String argument conforming a list with each individual letter char found in the String.
void	setLetterOptionsString(java.lang.String letterOptionsString)
void	setRules(java.lang.String rules)
java.lang.String	toString()

Methods inherited from class com.prowidesoftware.swift.scheme.BaseSchemeElement

asField, asFieldSet, getDescription, getId, getMaxRepetitions, getMinRepetitions, getName, isEditable, isField, isFieldSet, isMandatory, isOptional, isRepetitive, isSequence, isUnlimited, isVisible, setDescription, setEditable, setId, setMaxRepetitions, setMinRepetitions, setName, setVisible

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_LETTER

public static final java.lang.String NO_LETTER

See Also:

Constant Field Values

Constructor Detail

BaseSchemeFieldElement

protected BaseSchemeFieldElement()

BaseSchemeFieldElement

protected BaseSchemeFieldElement(java.lang.String name)

BaseSchemeFieldElement

protected BaseSchemeFieldElement(java.lang.String name,
                      java.lang.Integer minRepetitions,
                      java.lang.Integer maxRepetitions)

BaseSchemeFieldElement

protected BaseSchemeFieldElement(java.lang.String name,
                      java.lang.Integer minRepetitions,
                      java.lang.Integer maxRepetitions,
                      java.util.List<java.lang.String> letterOptions)

BaseSchemeFieldElement

protected BaseSchemeFieldElement(java.lang.String name,
                      java.lang.Integer minRepetitions,
                      java.lang.Integer maxRepetitions,
                      java.lang.String letterOptions)

BaseSchemeFieldElement

protected BaseSchemeFieldElement(java.lang.String name,
                      java.util.List<java.lang.String> letterOptions)

BaseSchemeFieldElement

protected BaseSchemeFieldElement(java.lang.String name,
                      java.lang.String letterOptions)

Method Detail

addEval

public void addEval(SchemeEval eval)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class BaseSchemeElement

getEvals

public java.util.List<SchemeEval> getEvals()

getLetterOptions

public java.util.List<java.lang.String> getLetterOptions()

Returns:

the letterOptions

getLetterOptionsString

public java.lang.String getLetterOptionsString()

getNumber

public int getNumber()

Returns the field id converted to a number.

Returns:

int value of the id attribute

getRules

public java.lang.String getRules()

getRulesAsList

public java.util.List<java.lang.String> getRulesAsList()

getTagNames

public java.util.List<java.lang.String> getTagNames()

Returns the list of tag names that this field supports, concatenating the field number with the letter options; and considering the NO_LETTER option as well.

hashCode

public int hashCode()

Overrides:

hashCode in class BaseSchemeElement

isLetter

public boolean isLetter(java.lang.String letter)

Returns true if the field has only one letter option and the letter is equals to the parameter letter

setEvals

public void setEvals(java.util.List<SchemeEval> evals)

setLetterOptions

public void setLetterOptions(java.util.List<java.lang.String> letterOptions)

Parameters:

letterOptions - the letterOptions to set

setLetterOptions

public void setLetterOptions(java.lang.String letterOptions)

This method parses the String argument conforming a list with each individual letter char found in the String.

Parameters:

letterOptions - the letterOptions to set in a String with the comma separated letters

setLetterOptionsString

public void setLetterOptionsString(java.lang.String letterOptionsString)

setRules

public void setRules(java.lang.String rules)

toString

public java.lang.String toString()

Overrides:

toString in class BaseSchemeElement