Package org.apache.sis.feature

Class MultiValuedAssociation

java.lang.Object

org.apache.sis.feature.Property

org.apache.sis.feature.Field<AbstractFeature>

org.apache.sis.feature.AbstractAssociation

org.apache.sis.feature.MultiValuedAssociation

All Implemented Interfaces:

Serializable, Cloneable

final class MultiValuedAssociation
extends AbstractAssociation

An instance of an association role containing an arbitrary number of values.

Note: in the common case where the association role restricts the cardinality to [0 … 1], the SingletonAssociation implementation consumes less memory.

Limitations

• Multi-threading: MultiValuedAssociation instances are not thread-safe. Synchronization, if needed, shall be done externally by the caller.
• Serialization: serialized objects of this class are not guaranteed to be compatible with future versions. Serialization should be used only for short term storage or RMI between applications running the same SIS version.

Since:

0.5

Version:

0.6

See Also:

• DefaultAssociationRole

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID	For cross-version compatibility.
private CheckedArrayList<AbstractFeature>	values	The association values.

Fields inherited from class org.apache.sis.feature.AbstractAssociation

role

Constructor Summary

Constructors

Constructor	Description
MultiValuedAssociation(DefaultAssociationRole role)	Creates a new association of the given role.
MultiValuedAssociation(DefaultAssociationRole role, Object values)	Creates a new association of the given role initialized to the given values.

Method Summary

Modifier and Type	Method	Description
MultiValuedAssociation	clone()	Returns a copy of this association.
boolean	equals(Object obj)	Compares this association with the given object for equality.
AbstractFeature	getValue()	Returns the feature, or null if none.
Collection<AbstractFeature>	getValues()	Returns all features, or an empty collection if none.
int	hashCode()	Returns a hash code value for this association.
void	setValue(AbstractFeature value)	Sets the feature.
void	setValues(Collection<? extends AbstractFeature> newValues)	Sets the feature values.

Methods inherited from class org.apache.sis.feature.AbstractAssociation

create, create, ensureValid, getName, getRole, quality, toString

Methods inherited from class org.apache.sis.feature.Field

isDeprecated, isSingleton

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

For cross-version compatibility.

See Also:

• Constant Field Values

values

private CheckedArrayList<AbstractFeature> values

The association values.

Constructor Details

MultiValuedAssociation

public MultiValuedAssociation(DefaultAssociationRole role)

Creates a new association of the given role.

Parameters:

role - Information about the association.

MultiValuedAssociation

MultiValuedAssociation(DefaultAssociationRole role,
 Object values)

Creates a new association of the given role initialized to the given values.

Parameters:

role - Information about the association.

values - The initial values, or null for initializing to an empty list.

Method Details

getValue

public AbstractFeature getValue()

Returns the feature, or null if none.

Specified by:

getValue in class AbstractAssociation

Returns:

the feature (may be null).

Throws:

IllegalStateException - if this association contains more than one value.

See Also:

• AbstractFeature.getPropertyValue(String)

getValues

public Collection<AbstractFeature> getValues()

Returns all features, or an empty collection if none. The returned collection is live: changes in the returned collection will be reflected immediately in this Association instance, and conversely.

Overrides:

getValues in class AbstractAssociation

Returns:

the features in a live collection.

setValue

public void setValue(AbstractFeature value)

Sets the feature.

Specified by:

setValue in class AbstractAssociation

Parameters:

value - the new value, or null for removing all values from this association.

See Also:

• AbstractFeature.setPropertyValue(String, Object)

setValues

public void setValues(Collection<? extends AbstractFeature> newValues)

Sets the feature values. All previous values are replaced by the given collection.

Overrides:

setValues in class AbstractAssociation

Parameters:

newValues - the new values.

clone

public MultiValuedAssociation clone()
                             throws CloneNotSupportedException

Returns a copy of this association. This implementation returns a shallow copy: the association values are not cloned.

Overrides:

clone in class AbstractAssociation

Returns:

a clone of this association.

Throws:

CloneNotSupportedException - if this association cannot be cloned.

hashCode

public int hashCode()

Returns a hash code value for this association.

Overrides:

hashCode in class Object

Returns:

a hash code value.

equals

public boolean equals(Object obj)

Compares this association with the given object for equality.

Overrides:

equals in class Object

Returns:

true if both objects are equal.