com.prowidesoftware.swift.scheme

Class SchemeFieldSet

java.lang.Object

com.prowidesoftware.swift.scheme.BaseSchemeElement

com.prowidesoftware.swift.scheme.BaseSchemeFieldElement

com.prowidesoftware.swift.scheme.SchemeFieldSet

public class SchemeFieldSet
extends BaseSchemeFieldElement

This class represent a set of fields in a message scheme.

Author:

www.prowidesoftware.com

Field Summary

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

NO_LETTER

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

editable, maxRepetitions, minRepetitions, name, UNLIMITED, visible

Constructor Summary

Constructors

Constructor and Description
SchemeFieldSet()
SchemeFieldSet(java.util.List<SchemeFieldSetItem> items)
SchemeFieldSet(java.lang.String name, java.lang.Integer minRepetitions, java.lang.Integer maxRepetitions, java.lang.String letterOptions)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addItem(SchemeFieldSetItem o)
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.String>	getAllLetterOptions() Returns the letter options expected for the fieldset, this may be defined for the filedset itself or may be defined on the fieldset items.
java.util.List<SchemeEval>	getEvals(SchemeFieldSetItem item) Return the list of eval expressions of this fieldset plus the evals of the given item
int	getIndex() Returns the field index of the first item of this fieldset or -1 if the fiedset is empty
java.util.List<SchemeFieldSetItem>	getItems()
java.util.List<SchemeFieldSetItem>	getMandatoryItems() Return the list of items that are mandatory
java.util.List<SchemeFieldQualifier>	getQualifiers()
int	hashCode()
void	setItems(java.util.List<SchemeFieldSetItem> items)
java.lang.String	toString()

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

addEval, getEvals, getLetterOptions, getLetterOptionsString, getNumber, getRules, getRulesAsList, getTagNames, isLetter, setEvals, setLetterOptions, setLetterOptions, setLetterOptionsString, setRules

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

Constructor Detail

SchemeFieldSet

public SchemeFieldSet()

SchemeFieldSet

public SchemeFieldSet(java.util.List<SchemeFieldSetItem> items)

SchemeFieldSet

public SchemeFieldSet(java.lang.String name,
              java.lang.Integer minRepetitions,
              java.lang.Integer maxRepetitions,
              java.lang.String letterOptions)

Method Detail

addItem

public boolean addItem(SchemeFieldSetItem o)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class BaseSchemeFieldElement

getAllLetterOptions

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

Returns the letter options expected for the fieldset, this may be defined for the filedset itself or may be defined on the fieldset items.

Returns:

the letterOptions all expected letter options defined for the fieldset and its items

getEvals

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

Return the list of eval expressions of this fieldset plus the evals of the given item

getIndex

public int getIndex()

Returns the field index of the first item of this fieldset or -1 if the fiedset is empty

getItems

public java.util.List<SchemeFieldSetItem> getItems()

getMandatoryItems

public java.util.List<SchemeFieldSetItem> getMandatoryItems()

Return the list of items that are mandatory

getQualifiers

public java.util.List<SchemeFieldQualifier> getQualifiers()

hashCode

public int hashCode()

Overrides:

hashCode in class BaseSchemeFieldElement

setItems

public void setItems(java.util.List<SchemeFieldSetItem> items)

toString

public java.lang.String toString()

Overrides:

toString in class BaseSchemeFieldElement