ilog.views.graphic

Class IlvURLKeyTable

java.lang.Object

ilog.views.graphic.IlvURLKeyTable

All Implemented Interfaces:

IlvPersistentObject

public class IlvURLKeyTable
extends Object
implements IlvPersistentObject

A table of URLs. Each URL is associated with a key string. This is mainly used as auxiliary class for IlvMultipleIcon. The same URL table can be shared among different IlvMultipleIcon instances.

Since:

JViews 8.5

Constructor Summary

Constructors

Constructor and Description
IlvURLKeyTable() Creates a new empty table.
IlvURLKeyTable(IlvInputStream stream) Reads the object from an IlvInputStream.
IlvURLKeyTable(IlvURLKeyTable source) Creates a copy of the source table.

Method Summary

Modifier and Type	Method and Description
void	add(String key, URL url) Adds a URL associated with the key at the end of the table.
int	getIndex(String key) Returns the index of the input key.
String[]	getKey() Returns the keys.
String	getKey(int index) Returns the key for a given index.
int	getLastIndex(String key) Returns the last index of the input key.
URL[]	getURL() Returns the URLs.
URL	getURL(int index) Returns the URL for a given index.
URL	getURL(String key) Returns the URL for a given key.
void	remove(int index) Removes the entry at the given index.
void	remove(String key) Removes the entry for a given key.
void	set(int index, String key, URL url) Sets the URL associated with the key at a given index of the table.
void	setKey(int index, String key) Sets the key for a given index.
void	setKey(String[] keys) Sets the keys.
void	setURL(int index, URL url) Sets the URL for a given index.
void	setURL(URL[] urls) Sets the URLs.
int	size() Returns the length of the table.
void	trim() Trims the table.
void	write(IlvOutputStream stream) Writes the object to an IlvOutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvURLKeyTable

public IlvURLKeyTable()

Creates a new empty table.

IlvURLKeyTable

public IlvURLKeyTable(IlvURLKeyTable source)

Creates a copy of the source table.

IlvURLKeyTable

public IlvURLKeyTable(IlvInputStream stream)
               throws IlvReadFileException

Reads the object from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if the format is not correct.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

size

public int size()

Returns the length of the table.

add

public void add(String key,
                URL url)

Adds a URL associated with the key at the end of the table. The size of the table increases by one.

set

public void set(int index,
                String key,
                URL url)

Sets the URL associated with the key at a given index of the table. The size of the table increases if it does not hold that many entries yet.

trim

public void trim()

Trims the table. All entries containing null keys and null URLs at the end of the table are removed.

remove

public void remove(int index)

Removes the entry at the given index. It removes the key and the URL at that entry. It trims the table if the last entry of the table was removed.

See Also:

trim()

remove

public void remove(String key)

Removes the entry for a given key. It removes the last occurrences of the key and the corresponding URL at that entry.

getIndex

public int getIndex(String key)

Returns the index of the input key.

getLastIndex

public int getLastIndex(String key)

Returns the last index of the input key.

getURL

public URL getURL(String key)

Returns the URL for a given key.

setURL

public void setURL(int index,
                   URL url)

Sets the URL for a given index.

Parameters:

index - The index.

url - The URL.

getURL

public URL getURL(int index)

Returns the URL for a given index.

Parameters:

index - The index.

Returns:

The URL.

setURL

public void setURL(URL[] urls)

Sets the URLs.

Parameters:

urls - The URLs.

getURL

public URL[] getURL()

Returns the URLs.

setKey

public void setKey(int index,
                   String key)

Sets the key for a given index.

Parameters:

index - The index.

key - The key.

getKey

public String getKey(int index)

Returns the key for a given index.

Parameters:

index - The index.

Returns:

The key.

setKey

public void setKey(String[] keys)

Sets the keys.

Parameters:

keys - The keys.

getKey

public String[] getKey()

Returns the keys.