Package it.bancaditalia.oss.vtl.impl.domains

Class StringCodeList

java.lang.Object

it.bancaditalia.oss.vtl.impl.domains.StringCodeList

All Implemented Interfaces:

EnumeratedDomainSubset<StringEnumeratedDomainSubset,StringDomain>, ValueDomain, ValueDomainSubset<StringEnumeratedDomainSubset,StringDomain>, StringDomain, StringDomainSubset<StringEnumeratedDomainSubset>, StringEnumeratedDomainSubset, Serializable

public class StringCodeList
extends Object
implements StringEnumeratedDomainSubset, Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	StringCodeList.StringCodeItemImpl

Nested classes/interfaces inherited from interface it.bancaditalia.oss.vtl.model.domain.StringEnumeratedDomainSubset

StringEnumeratedDomainSubset.StringCodeItem<I extends StringEnumeratedDomainSubset.StringCodeItem<I>>

Constructor Summary

Constructors

Constructor	Description
StringCodeList(String name, Set<? extends String> items)

Method Summary

Modifier and Type	Method	Description
StringCodeList.StringCodeItemImpl	cast(ScalarValue<?,?,?,?> value)	Casts the given ScalarValue to this ValueDomainSubset
boolean	equals(Object obj)
Set<StringCodeList.StringCodeItemImpl>	getCodeItems()	The returned set should not be altered in any way.
Object	getCriterion()
StringEnumeratedDomainSubset	getDomain()
String	getName()
StringDomain	getParentDomain()
String	getVarName()
int	hashCode()
boolean	isAssignableFrom(ValueDomain other)	Check if a value of a given ValueDomain can be converted to a value of this ValueDomain
boolean	isComparableWith(ValueDomain other)	Check if a value of a given ValueDomain can be compared to a value of this ValueDomain
StringEnumeratedDomainSubset	lcase()	Creates a new StringEnumeratedDomainSubset by converting in lower case each code item of this StringEnumeratedDomainSubset.
StringEnumeratedDomainSubset	ltrim()	Creates a new StringEnumeratedDomainSubset by trimming all leading whitespace from each code item of this StringEnumeratedDomainSubset.
StringEnumeratedDomainSubset	rtrim()	Creates a new StringEnumeratedDomainSubset by trimming all trailing whitespace from each code item of this StringEnumeratedDomainSubset.
String	toString()
StringEnumeratedDomainSubset	trim()	Creates a new StringEnumeratedDomainSubset by trimming all leading and trailing whitespace from each code item of this StringEnumeratedDomainSubset.
StringEnumeratedDomainSubset	ucase()	Creates a new StringEnumeratedDomainSubset by converting in upper case each code item of this StringEnumeratedDomainSubset.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringCodeList

public StringCodeList(String name,
                      Set<? extends String> items)

Method Detail

getName

public String getName()

Specified by:

getName in interface EnumeratedDomainSubset<StringEnumeratedDomainSubset,StringDomain>

Returns:

the domain name.

getDomain

public StringEnumeratedDomainSubset getDomain()

Specified by:

getDomain in interface EnumeratedDomainSubset<StringEnumeratedDomainSubset,StringDomain>

Returns:

the original domain.

getCriterion

public Object getCriterion()

Specified by:

getCriterion in interface ValueDomainSubset<StringEnumeratedDomainSubset,StringDomain>

Returns:

A criterion, if defined, to limit the admissible values from the parent ValueDomain

getParentDomain

public StringDomain getParentDomain()

Specified by:

getParentDomain in interface ValueDomainSubset<StringEnumeratedDomainSubset,StringDomain>

Returns:

the parent ValueDomain

cast

public StringCodeList.StringCodeItemImpl cast(ScalarValue<?,?,?,?> value)

Description copied from interface: ValueDomainSubset

Casts the given ScalarValue to this ValueDomainSubset

Specified by:

cast in interface EnumeratedDomainSubset<StringEnumeratedDomainSubset,StringDomain>

Specified by:

cast in interface StringDomainSubset<StringEnumeratedDomainSubset>

Specified by:

cast in interface StringEnumeratedDomainSubset

Specified by:

cast in interface ValueDomainSubset<StringEnumeratedDomainSubset,StringDomain>

Parameters:

value - the ScalarValue to cast

Returns:

the casted ScalarValue

isAssignableFrom

public boolean isAssignableFrom(ValueDomain other)

Description copied from interface: ValueDomain

Check if a value of a given ValueDomain can be converted to a value of this ValueDomain

Specified by:

isAssignableFrom in interface ValueDomain

Parameters:

other - the other ValueDomain

Returns:

true if the conversion is possible

isComparableWith

public boolean isComparableWith(ValueDomain other)

Description copied from interface: ValueDomain

Check if a value of a given ValueDomain can be compared to a value of this ValueDomain

Specified by:

isComparableWith in interface StringDomain

Specified by:

isComparableWith in interface ValueDomain

Parameters:

other - the other ValueDomain

Returns:

true if the comparison is possible

getVarName

public String getVarName()

Specified by:

getVarName in interface ValueDomain

Returns:

the default variable name for DataStructureComponents of this ValueDomain

getCodeItems

public Set<StringCodeList.StringCodeItemImpl> getCodeItems()

Description copied from interface: EnumeratedDomainSubset

The returned set should not be altered in any way.

Specified by:

getCodeItems in interface EnumeratedDomainSubset<StringEnumeratedDomainSubset,StringDomain>

Specified by:

getCodeItems in interface StringEnumeratedDomainSubset

Returns:

the set of all the code items in this domain.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface ValueDomainSubset<StringEnumeratedDomainSubset,StringDomain>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface ValueDomainSubset<StringEnumeratedDomainSubset,StringDomain>

Overrides:

equals in class Object

trim

public StringEnumeratedDomainSubset trim()

Description copied from interface: StringEnumeratedDomainSubset

Creates a new StringEnumeratedDomainSubset by trimming all leading and trailing whitespace from each code item of this StringEnumeratedDomainSubset.

Specified by:

trim in interface StringEnumeratedDomainSubset

Returns:

the new domain.

ltrim

public StringEnumeratedDomainSubset ltrim()

Description copied from interface: StringEnumeratedDomainSubset

Creates a new StringEnumeratedDomainSubset by trimming all leading whitespace from each code item of this StringEnumeratedDomainSubset.

Specified by:

ltrim in interface StringEnumeratedDomainSubset

Returns:

the new domain.

rtrim

public StringEnumeratedDomainSubset rtrim()

Description copied from interface: StringEnumeratedDomainSubset

Creates a new StringEnumeratedDomainSubset by trimming all trailing whitespace from each code item of this StringEnumeratedDomainSubset.

Specified by:

rtrim in interface StringEnumeratedDomainSubset

Returns:

the new domain.

ucase

public StringEnumeratedDomainSubset ucase()

Description copied from interface: StringEnumeratedDomainSubset

Creates a new StringEnumeratedDomainSubset by converting in upper case each code item of this StringEnumeratedDomainSubset.

Specified by:

ucase in interface StringEnumeratedDomainSubset

Returns:

the new domain.

lcase

public StringEnumeratedDomainSubset lcase()

Description copied from interface: StringEnumeratedDomainSubset

Creates a new StringEnumeratedDomainSubset by converting in lower case each code item of this StringEnumeratedDomainSubset.

Specified by:

lcase in interface StringEnumeratedDomainSubset

Returns:

the new domain.