com.moximedia.aims
Class AimsDataset

java.lang.Object
  com.moximedia.aims.AimsDataset

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class AimsDataset

extends java.lang.Object

implements java.io.Serializable, java.lang.Cloneable

Implementation of ArcIMS DATASET element. Used when adding dynamic layers to the map.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Constructor Summary

AimsDataset()
Creates new AimsDataset with null values.

AimsDataset(java.lang.String name, java.lang.String workspaceName, java.lang.String type)
Creates new AimsDataset with the specified values.

Method Summary

java.lang.Object	clone() Returns a clone of this object.
AimsDataset	getCopy() Returns a clone of this object.
java.lang.String	getDescription() Gets the description for the dataset.
java.lang.String	getName() Gets the data source for the dataset.
boolean	getShowColorMapLegend() Gets the showcolormaplegend property for the dataset.
java.lang.String	getType() Gets the type for the dataset, either image, point, line or polygon.
java.lang.String	getWorkspaceName() Gets the workspace name code for the dataset.
void	setAxlAttribute(java.lang.String element, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
void	setDescription(java.lang.String description) Sets the description for the dataset, used for images in ArcIMS 9 or later.
void	setName(java.lang.String name) Sets the data source for the dataset.
void	setShowColorMapLegend(boolean show) Sets the showcolormaplegend property for the dataset.
void	setType(java.lang.String type) Sets the type for the dataset, either image, point, line or polygon.
void	setWorkspaceName(java.lang.String workspace) Sets the workspace name code for the dataset.
java.lang.String	toAxlString() Returns the AXL string to refresh this object, using the default environnment setting.
java.lang.String	toAxlString(AimsEnvironment env) Returns the AXL string to refresh this object, using the specified environnment setting.

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsDataset

public AimsDataset()

Creates new AimsDataset with null values.

AimsDataset

public AimsDataset(java.lang.String name,
                   java.lang.String workspaceName,
                   java.lang.String type)

Creates new AimsDataset with the specified values.

Parameters:

name - The name of the shapefile, image, image catalog, or sde layer.

workspaceName - The workspace name.

type - The type of dataset point, line, polygon, image.

Method Detail

clone

public java.lang.Object clone()

Returns a clone of this object.

Returns:

A cloned copy of this object.

getCopy

public AimsDataset getCopy()

Returns a clone of this object.

Returns:

A cloned copy of this object.

getDescription

public java.lang.String getDescription()

Gets the description for the dataset.

Returns:

The description for the dataset, corresponds to the description attribute in the DATASET element.

setDescription

public void setDescription(java.lang.String description)

Sets the description for the dataset, used for images in ArcIMS 9 or later.

Parameters:

description - The description for the dataset, corresponds to the description attribute in the DATASET element. See the AXL documentation for DATASET.

getName

public java.lang.String getName()

Gets the data source for the dataset.

Returns:

The data source for the dataset, corresponds to the name attribute in the DATASET element.

setName

public void setName(java.lang.String name)

Sets the data source for the dataset.

Parameters:

name - The data source for the dataset, corresponds to the name attribute in the DATASET element. See the AXL documentation for DATASET.

getWorkspaceName

public java.lang.String getWorkspaceName()

Gets the workspace name code for the dataset.

Returns:

The workspace name for the dataset, corresponds to the workspace attribute in the DATASET element. See the AXL documentation for DATASET.

setWorkspaceName

public void setWorkspaceName(java.lang.String workspace)

Sets the workspace name code for the dataset.

Parameters:

workspace - The workspace name for the dataset, corresponds to the workspace attribute in the DATASET element. See the AXL documentation for DATASET.

getShowColorMapLegend

public boolean getShowColorMapLegend()

Gets the showcolormaplegend property for the dataset.

Returns:

The boolean value.

setShowColorMapLegend

public void setShowColorMapLegend(boolean show)

Sets the showcolormaplegend property for the dataset.

Parameters:

show - The boolean value. See the AXL documentation for DATASET for more information.

getType

public java.lang.String getType()

Gets the type for the dataset, either image, point, line or polygon.

Returns:

The data type for the dataset.

setType

public void setType(java.lang.String type)

Sets the type for the dataset, either image, point, line or polygon.

Parameters:

type - The data type for the dataset. See the AXL documentation for DATASET for valid types.

setAxlAttribute

public void setAxlAttribute(java.lang.String element,
                            java.lang.String name,
                            java.lang.String value)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

element - The AXL element tag containing this attribute.

name - The AXL attribute name.

value - The AXL attribute value.

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object, using the default environnment setting. This method is not typically used by the application programmer.

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env)

Returns the AXL string to refresh this object, using the specified environnment setting. This method is not typically used by the application programmer.

Parameters:

env - The environment object containing coordinate separators.

Returns:

The AXL string to refresh this object.