ilog.views.maps

Class IlvAttributeProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.maps.IlvAttributeProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

Direct Known Subclasses:

IlvFeatureAttributeProperty

public class IlvAttributeProperty
extends IlvNamedProperty

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

A subclass, IlvFeatureAttributeProperty, is optimized to store the attributes of the map features.

See Also:

IlvAttributeInfoProperty, IlvFeatureAttributeProperty, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of the property

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Copies the property.
IlvAttributeInfoProperty	getInfo() Returns information about the attribute values.
Object	getValue(int i) Returns the value of the attribute specified by the index i.
Object	getValue(String name) Returns the value of the attribute specified by its name.
boolean	isPersistent() Returns true if the property must be saved to an IVL file.
void	setPersistent(boolean persistent) Specifies whether the property must be saved to an IVL file.
void	setValue(int i, Object value) Sets the value of the attribute specified by the index i to value.
void	setValue(String name, Object value) Sets the value of the attribute specified by its name to value.
void	unsafeSetValue(int i, Object value) Sets the value of the attribute specified by its index to value.
void	write(IlvOutputStream stream) Writes the property to an IlvOutputStream.

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

Field Detail

NAME

public static final String NAME

The name of the property

See Also:

Constant Field Values

Constructor Detail

IlvAttributeProperty

public IlvAttributeProperty(IlvAttributeInfoProperty info,
                            Object[] values)

Creates an instance of the class IlvAttributeProperty.

Parameters:

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

values - The values of the 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 .

IlvAttributeProperty

public IlvAttributeProperty(IlvAttributeProperty source)

Creates a new IlvNamedProperty 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 values are copied. Modifying the values of the copied object using the method setValue will not alter the source object, and vice versa.

Parameters:

source - The named property to be copied

IlvAttributeProperty

public IlvAttributeProperty(IlvInputStream stream)
                     throws IlvReadFileException

Creates a new IlvAttributeInfoProperty from an IlvInputStream.

Parameters:

stream - the input stream.

Throws:

IlvReadFileException - if an error occurs while reading.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the property to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvNamedProperty

Parameters:

stream - the output stream.

Throws:

IOException - standard IO error.

getInfo

public IlvAttributeInfoProperty getInfo()

Returns information about the attribute values.

getValue

public Object getValue(int i)

Returns the value of the attribute specified by the index i.

Parameters:

i - The index of the attribute

getValue

public Object getValue(String name)

Returns the value of the attribute specified by its name.

Parameters:

name - The name of the attribute

Throws:

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

setValue

public void setValue(int i,
                     Object value)

Sets the value of the attribute specified by the index i to value. This method checks consistency of assignment, that is:

• class of object value is assignable to the corresponding class in associated IlvAttributeInfoProperty object;
• value is not null when the value at position i is not nullable.

Parameters:

i - The index of the attribute to be set.

value - 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.

setValue

public void setValue(String name,
                     Object value)

Sets the value of the attribute specified by its name to value. This method checks consistency of assignment, that is:

• class of object value is assignable to the corresponding class in associated IlvAttributeInfoProperty object;
• value is not null when the value is not nullable.

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.

unsafeSetValue

public void unsafeSetValue(int i,
                           Object value)

Sets the value of the attribute specified by its index to value. This function does not check for any class or nullable value.

Parameters:

i - The index of attribute to be set

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

Throws:

IllegalArgumentException - if index is higher than the number of attributes.

Since:

JViews 3.0

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 internal array of values is copied. Modifying the values of the copied object using setValue will not alter the source object and vice versa.

Specified by:

copy in class IlvNamedProperty

setPersistent

public void setPersistent(boolean persistent)

Specifies whether the property must be saved to an IVL file. By default, the property is persistent.

Parameters:

persistent - Set to true if the property must be saved to an IVL file or false otherwise.

isPersistent

public boolean isPersistent()

Returns true if the property must be saved to an IVL file. By default, the property is persistent.

Specified by:

isPersistent in class IlvNamedProperty