com.moximedia.aims
Class AimsField

java.lang.Object
  com.moximedia.aims.AimsField

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class AimsField

extends java.lang.Object

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

The AimsField class contains the definition of a recordset field. The actual contents are stored in the AimsFeature class.

See Also:

Serialized Form

Field Summary

static int	CASE_INSENSITIVE
static int	CASE_LOWER
static int	CASE_SENSITIVE
static int	CASE_UPPER
static int	FIELD_TYPE_BIG_INTEGER
static int	FIELD_TYPE_BOOLEAN
static int	FIELD_TYPE_CHAR
static int	FIELD_TYPE_DATE
static int	FIELD_TYPE_DOUBLE
static int	FIELD_TYPE_FLOAT
static int	FIELD_TYPE_INTEGER
static int	FIELD_TYPE_LONG_INTEGER
static int	FIELD_TYPE_ROWID
static int	FIELD_TYPE_SHAPE
static int	FIELD_TYPE_STRING

Constructor Summary

AimsField()
Creates a new AimsField object.

AimsField(java.lang.String name)
Creates a new AimsField object.

Method Summary

boolean	canExtractExcel() Returns an indicator of whether this field is included in an Excel extraction.
boolean	canExtractGml() Returns an indicator of whether this field is included in a GML extraction.
boolean	canFindByAttribute() Returns a boolean value indicating whether this field can be used in seraching for features using an attribute.
boolean	canIdentify() Returns a boolean indicator of whether the field is included in the identify report.
boolean	canSelectByAttribute() Returns a boolean value indicating whether this field can be used in seraching for features using an attribute.
java.lang.Object	clone() Returns a copy of this field object.
java.lang.String	format(java.lang.String value)
java.lang.String	getAlias() Gets the alias label of the field.
boolean	getCanSymbolizeByAttribute() Gets whether the layer can be symbolized by this field.
double	getFindByAttributeBuffer() Gets the find by attribute buffer distance for use in zooming to the features found when using the Find By Attribute tool.
int	getFindByAttributeCase() Gets the find by attribute case for use in converting the string entered by the user to the case expected by the database.
java.lang.String	getHypertextMessage() Gets the hypertext message for the field to be displayed when the field contains a link to another document.
java.lang.String	getIdentifyAlias() Gets the alias label of the field.
java.lang.String	getIdentifyLinkAlias() Gets the alias label of the field.
java.lang.String	getMapTipAlias() Returns the map tip alias, if any.
java.lang.String	getMetadataUrl() Returns the URL to the metadata page for this field, or null if no metatata URL is defined.
java.lang.String	getName() Gets the name of the field
int	getPrecision() Gets the precision of the field
java.lang.String	getSdeTableName()
java.lang.String	getSelectAlias() Gets the alias label of the field.
double	getSelectByAttributeBuffer() Gets the select by attribute buffer distance for use in zooming to the features found when using the Find By Attribute tool.
int	getSelectByAttributeCase() Gets the find by attribute case for use in converting the string entered by the user to the case expected by the database.
boolean	getSelectByAttributeZoom() Returns whether the select by attribute routine should zoom to the extent of the selected features.
java.lang.String	getShortName() Gets the alias label of the field, or the short SDE field name (the part after the last period.
java.lang.String	getShortNameNoAlias() Gets the short SDE field name (the part after the last period).
int	getSize() Gets the size of the field
int	getType() Gets the field type.
boolean	isDateType()
boolean	isMapTipField() Returns whether map tips are shown for this field.
void	isMapTipField(boolean showMapTip) Sets whether map tips are shown for this field.
boolean	isNumberType()
boolean	isSde() Returns an indicator of whether the field is an SDE column.
boolean	isServiceField()
boolean	isStringType()
void	setAlias(java.lang.String alias) Sets the alias for a field
void	setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
void	setCanIdentify(boolean doIdentify) Sets whether the field is included in the identify report.
void	setCanSymbolizeByAttribute(boolean canSymbolize) Sets whether the layer can be symbolized by this field.
void	setMapTipAlias(java.lang.String alias) Returns the map tip alias.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_TYPE_ROWID

public static final int FIELD_TYPE_ROWID

See Also:

Constant Field Values

FIELD_TYPE_SHAPE

public static final int FIELD_TYPE_SHAPE

See Also:

Constant Field Values

FIELD_TYPE_BOOLEAN

public static final int FIELD_TYPE_BOOLEAN

See Also:

Constant Field Values

FIELD_TYPE_BIG_INTEGER

public static final int FIELD_TYPE_BIG_INTEGER

See Also:

Constant Field Values

FIELD_TYPE_CHAR

public static final int FIELD_TYPE_CHAR

See Also:

Constant Field Values

FIELD_TYPE_INTEGER

public static final int FIELD_TYPE_INTEGER

See Also:

Constant Field Values

FIELD_TYPE_LONG_INTEGER

public static final int FIELD_TYPE_LONG_INTEGER

See Also:

Constant Field Values

FIELD_TYPE_FLOAT

public static final int FIELD_TYPE_FLOAT

See Also:

Constant Field Values

FIELD_TYPE_DOUBLE

public static final int FIELD_TYPE_DOUBLE

See Also:

Constant Field Values

FIELD_TYPE_STRING

public static final int FIELD_TYPE_STRING

See Also:

Constant Field Values

FIELD_TYPE_DATE

public static final int FIELD_TYPE_DATE

See Also:

Constant Field Values

CASE_SENSITIVE

public static final int CASE_SENSITIVE

See Also:

Constant Field Values

CASE_UPPER

public static final int CASE_UPPER

See Also:

Constant Field Values

CASE_LOWER

public static final int CASE_LOWER

See Also:

Constant Field Values

CASE_INSENSITIVE

public static final int CASE_INSENSITIVE

See Also:

Constant Field Values

Constructor Detail

AimsField

public AimsField()

Creates a new AimsField object. DO NOT USE. For serialization only.

AimsField

public AimsField(java.lang.String name)

Creates a new AimsField object.

Parameters:

name - The field name.

Method Detail

canExtractExcel

public boolean canExtractExcel()

Returns an indicator of whether this field is included in an Excel extraction.

Returns:

True if this field is included in the Excel extracted, otherwise false.

canExtractGml

public boolean canExtractGml()

Returns an indicator of whether this field is included in a GML extraction.

Returns:

True if this field is included in the GML extracted, otherwise false.

clone

public java.lang.Object clone()

Returns a copy of this field object.

Returns:

A copy of this field object as an Object. Cast it back to an AimsField before using.

canFindByAttribute

public boolean canFindByAttribute()

Returns a boolean value indicating whether this field can be used in seraching for features using an attribute.

Returns:

True if the field can be searched, otherwise false.

getFindByAttributeBuffer

public double getFindByAttributeBuffer()

Gets the find by attribute buffer distance for use in zooming to the features found when using the Find By Attribute tool.

Returns:

The buffer distance

getFindByAttributeCase

public int getFindByAttributeCase()

Gets the find by attribute case for use in converting the string entered by the user to the case expected by the database.

Returns:

The case to use, one of the following: AimsField.CASE_SENSITIVE, CASE_UPPER, CASE_LOWER, or CASE_INSENSITIVE.

canSelectByAttribute

public boolean canSelectByAttribute()

Returns a boolean value indicating whether this field can be used in seraching for features using an attribute.

Returns:

True if the field can be searched, otherwise false.

getSelectByAttributeBuffer

public double getSelectByAttributeBuffer()

Gets the select by attribute buffer distance for use in zooming to the features found when using the Find By Attribute tool.

Returns:

The buffer distance

getSelectByAttributeCase

public int getSelectByAttributeCase()

Gets the find by attribute case for use in converting the string entered by the user to the case expected by the database.

Returns:

The case to use, one of the following: AimsField.CASE_SENSITIVE, CASE_UPPER, CASE_LOWER, or CASE_INSENSITIVE.

getSelectByAttributeZoom

public boolean getSelectByAttributeZoom()

Returns whether the select by attribute routine should zoom to the extent of the selected features. Set with select-by-attribute-zoom attribute in field element of layer configuration XML.

Returns:

True if the routine zooms, otherwise false.

getMetadataUrl

public java.lang.String getMetadataUrl()

Returns the URL to the metadata page for this field, or null if no metatata URL is defined.

Returns:

The URL to the metadata page for this field, or null if no metatata URL is defined.

getShortName

public java.lang.String getShortName()

Gets the alias label of the field, or the short SDE field name (the part after the last period.

Returns:

The alias label of the field, or the short name if there is no alias.

getShortNameNoAlias

public java.lang.String getShortNameNoAlias()

Gets the short SDE field name (the part after the last period).

Returns:

The short name.

getAlias

public java.lang.String getAlias()

Gets the alias label of the field.

Returns:

The alias label of the field, or the name if there is no alias.

getSelectAlias

public java.lang.String getSelectAlias()

Gets the alias label of the field.

Returns:

The alias label of the field, or the name if there is no alias.

getIdentifyAlias

public java.lang.String getIdentifyAlias()

Gets the alias label of the field.

Returns:

The alias label of the field, or the name if there is no alias.

getIdentifyLinkAlias

public java.lang.String getIdentifyLinkAlias()

Gets the alias label of the field.

Returns:

The alias label of the field, or the name if there is no alias.

getHypertextMessage

public java.lang.String getHypertextMessage()

Gets the hypertext message for the field to be displayed when the field contains a link to another document.

Returns:

The hypertext message for the field

getName

public java.lang.String getName()

Gets the name of the field

Returns:

The name of the field

getPrecision

public int getPrecision()

Gets the precision of the field

Returns:

The precision of the field

getSize

public int getSize()

Gets the size of the field

Returns:

The size of the field

getType

public int getType()

Gets the field type. 4,5,6,8 number, 12 string. see ArxXML reference.

Returns:

The field type.

isStringType

public boolean isStringType()

isDateType

public boolean isDateType()

isNumberType

public boolean isNumberType()

setAlias

public void setAlias(java.lang.String alias)

Sets the alias for a field

Parameters:

alias - The alias to set.

setCanIdentify

public void setCanIdentify(boolean doIdentify)

Sets whether the field is included in the identify report.

Parameters:

doIdentify - True if this field should be included, otherwise false.

canIdentify

public boolean canIdentify()

Returns a boolean indicator of whether the field is included in the identify report.

Returns:

True if this field is included, otherwise false.

getCanSymbolizeByAttribute

public boolean getCanSymbolizeByAttribute()

Gets whether the layer can be symbolized by this field.

Returns:

True if the layer can be symbolized by this field, otherwise false. TODO: add support for numeric field symbolization

setCanSymbolizeByAttribute

public void setCanSymbolizeByAttribute(boolean canSymbolize)

Sets whether the layer can be symbolized by this field.

Parameters:

canSymbolize - True if the layer can be symbolized by this field, otherwise false.

isServiceField

public boolean isServiceField()

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            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:

tag - The AXL element tag containing this attribute (not used).

name - The AXL attribute name.

value - The AXL attribute value.

format

public java.lang.String format(java.lang.String value)

getMapTipAlias

public java.lang.String getMapTipAlias()

Returns the map tip alias, if any.

Returns:

The alias, or the field's short name.

setMapTipAlias

public void setMapTipAlias(java.lang.String alias)

Returns the map tip alias.

Parameters:

alias - The alias for the map tip routine.

isMapTipField

public boolean isMapTipField()

Returns whether map tips are shown for this field.

Returns:

True if map tips are shown, otherwise false.

isMapTipField

public void isMapTipField(boolean showMapTip)

Sets whether map tips are shown for this field.

Parameters:

showMapTip - True if map tips are shown, otherwise false.

isSde

public boolean isSde()

Returns an indicator of whether the field is an SDE column.

Returns:

True if the field has two dots, otherwise false.

getSdeTableName

public java.lang.String getSdeTableName()