ilog.views.maps

Class IlvFeatureAttributeProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.maps.IlvAttributeProperty

ilog.views.maps.IlvFeatureAttributeProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvFeatureAttributeProperty
extends IlvAttributeProperty

This class is used to store the values of map attributes. Since it is an IlvNamedProperty object, it can be attached to graphic object layers or managers, and, possibly, saved to ivl files.

Since:

Perforce JViews 3.0

See Also:

IlvMapFeature, IlvFeatureAttribute, Serialized Form

Field Summary

Fields inherited from class ilog.views.maps.IlvAttributeProperty

NAME

Constructor Summary

Constructors

Constructor and Description
IlvFeatureAttributeProperty(IlvAttributeInfoProperty info, IlvFeatureAttribute[] values) Creates an instance of the class IlvFeatureAttributeProperty.
IlvFeatureAttributeProperty(IlvFeatureAttributeProperty source) Creates a new IlvFeatureAttributeProperty object by copying an existing one.
IlvFeatureAttributeProperty(IlvInputStream stream) Creates a new IlvFeatureAttributeProperty object from an IlvInputStream object.

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Copies the property.
IlvFeatureAttribute	getAttribute(int i) Returns the attribute of the specified index.
IlvFeatureAttribute	getAttribute(String name) Returns the attribute specified by its name.
void	setAttribute(int i, IlvFeatureAttribute attribute) Sets the value of the attribute specified by the index i to value.
void	setAttribute(String name, IlvFeatureAttribute value) Sets the value of the attribute specified by its name to value.
void	unsafeSetAttribute(int i, IlvFeatureAttribute attribute) Sets the value of the attribute specified by the index i to value, without checking any conditions.

Methods inherited from class ilog.views.maps.IlvAttributeProperty

getInfo, getValue, getValue, isPersistent, setPersistent, setValue, setValue, unsafeSetValue, write

Methods inherited from class ilog.views.IlvNamedProperty

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvFeatureAttributeProperty

public IlvFeatureAttributeProperty(IlvAttributeInfoProperty info,
                                   IlvFeatureAttribute[] values)

Creates an instance of the class IlvFeatureAttributeProperty.

Parameters:

info - The description of the attributes (names, classes etc.)

values - The array of feature attributes

Throws:

IllegalArgumentException - if the array of values differs from the number of attributes specified by the info argument or if the classes of the values are different from the classes specified in info .

IlvFeatureAttributeProperty

public IlvFeatureAttributeProperty(IlvFeatureAttributeProperty source)

Creates a new IlvFeatureAttributeProperty object by copying an existing one. The IlvAttributeInfoProperty is not copied, which means that the source and the copy will share the same instance of IlvAttributeInfoProperty.

The attribute array and the attributes themselves are copied.

Parameters:

source - The feature attribute property to be copied.

IlvFeatureAttributeProperty

public IlvFeatureAttributeProperty(IlvInputStream stream)
                            throws IlvReadFileException

Creates a new IlvFeatureAttributeProperty object from an IlvInputStream object.

Parameters:

stream - The input stream

Throws:

IlvReadFileException - if an error occurs while reading.

Method Detail

getAttribute

public IlvFeatureAttribute getAttribute(int i)

Returns the attribute of the specified index.

Parameters:

i - The index of the attribute

Returns:

the attribute at index i.

getAttribute

public IlvFeatureAttribute getAttribute(String name)

Returns the attribute specified by its name.

Parameters:

name - The name of the attribute

Returns:

the attribute.

Throws:

IllegalArgumentException - if name is not the name of an attribute.

setAttribute

public void setAttribute(int i,
                         IlvFeatureAttribute attribute)

Sets the value of the attribute specified by the index i to value. The attribute values you set must be checked against the following conditions:

• When the attribute value to be set is not nullable, the new value must not be null.
• The class associated with the attribute must be assignable from the class of the new value.

Parameters:

i - The index of the attribute to be set

attribute - The value to which the specified attribute will be set.

Throws:

IllegalArgumentException - if the index is higher than the number of attributes or if the class of the value is incompatible with the class of this attribute.

unsafeSetAttribute

public void unsafeSetAttribute(int i,
                               IlvFeatureAttribute attribute)

Sets the value of the attribute specified by the index i to value, without checking any conditions. This method must be used with caution. If the conditions checked by the setAttribute method are not met, the object will be in an inconsistent state.

Parameters:

i - The index of the attribute to be set.

attribute - The value to which the specified attribute will be set.

setAttribute

public void setAttribute(String name,
                         IlvFeatureAttribute value)

Sets the value of the attribute specified by its name to value.

Parameters:

name - The name of the attribute to be set.

value - The value to which the specified attribute will be set.

Throws:

IllegalArgumentException - if name is not the name of an attribute or if the class of the value is incompatible with the class of this attribute.

copy

public IlvNamedProperty copy()

Copies the property. The IlvAttributeInfoProperty is not copied, that is the source and the copy will share the same instance of IlvAttributeInfoProperty.

The attribute array and the attributes themselves are copied.

Overrides:

copy in class IlvAttributeProperty

Returns:

a copy of this feature attribute property.