com.moximedia.aims
Class AimsReport

java.lang.Object
  com.moximedia.aims.AimsReport

All Implemented Interfaces:

java.io.Serializable

public class AimsReport

extends java.lang.Object

implements java.io.Serializable

Author:

jdc

See Also:

Serialized Form

Constructor Summary

AimsReport()
Creates a new instance of AimsReport

AimsReport(AimsFeatureLayer layer)
Creates a new instance of AimsReport

Method Summary

void	addLink(AimsIdentifyLink link) Adds a hyperlink to the default report.
AimsReport	getCopy()
java.lang.String	getDescription() Gets the description for this report.
AimsField	getField(java.lang.String name) Gets the field with the specified name.
java.util.ArrayList	getFields() Gets the fields for this report.
java.lang.String	getHandler() Gets the handler URL property.
java.util.ArrayList	getKeyFields() Gets the key fields.
AimsIdentifyLink[]	getLinks() Gets the links associated with the default report.
java.lang.String	getName() Gets the name for this report.
java.lang.String	getProperty(java.lang.String name) Gets the value of a property set in the configuration XML using a <property> element.
java.lang.String	getType() Gets the report type property.
boolean	isPopup() Gets an indicator of whether the report should open in a separate window.
void	moveField(AimsField fld, int toIndex) Moves a field to the specified position in the fields list.
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	setDescription(java.lang.String description) Sets the report description property.
void	setHandler(java.lang.String handler) Sets the handler URL property.
void	setKeyFields(java.lang.String fieldNames) Sets the key fields for this report.
void	setName(java.lang.String name) Sets the report name property.
void	setPopup(boolean popup) Sets the target window popup property.
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a property (programmer defined).
void	setType(java.lang.String type) Sets the report type property.

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsReport

public AimsReport()

Creates a new instance of AimsReport

AimsReport

public AimsReport(AimsFeatureLayer layer)

Creates a new instance of AimsReport

Method Detail

getCopy

public AimsReport getCopy()

getDescription

public java.lang.String getDescription()

Gets the description for this report.

Returns:

The name for this report.

setDescription

public void setDescription(java.lang.String description)

Sets the report description property.

Parameters:

description - The report description.

getField

public AimsField getField(java.lang.String name)

Gets the field with the specified name.

Returns:

The field with the specified name, or null if not found.

getFields

public java.util.ArrayList getFields()

Gets the fields for this report.

Returns:

The fields used for this report.

getHandler

public java.lang.String getHandler()

Gets the handler URL property.

Returns:

The handler URL.

setHandler

public void setHandler(java.lang.String handler)

Sets the handler URL property.

Parameters:

handler - The handler URL.

getKeyFields

public java.util.ArrayList getKeyFields()

Gets the key fields.

Returns:

The key fields.

setKeyFields

public void setKeyFields(java.lang.String fieldNames)

Sets the key fields for this report.

Parameters:

fieldNames - A comma separated list of field names.

getLinks

public AimsIdentifyLink[] getLinks()

Gets the links associated with the default report.

Returns:

The links as an array.

addLink

public void addLink(AimsIdentifyLink link)

Adds a hyperlink to the default report.

Parameters:

link - The link to add to the default report.

getName

public java.lang.String getName()

Gets the name for this report.

Returns:

The name for this report.

setName

public void setName(java.lang.String name)

Sets the report name property.

Parameters:

name - The report name.

getProperty

public java.lang.String getProperty(java.lang.String name)

Gets the value of a property set in the configuration XML using a <property> element.

Parameters:

name - The property name

Returns:

The property value, or null.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

Sets the value of a property (programmer defined).

Parameters:

name - The property name

value - The property value.

getType

public java.lang.String getType()

Gets the report type property.

Returns:

The type of report.

setType

public void setType(java.lang.String type)

Sets the report type property.

Parameters:

type - The type of report.

isPopup

public boolean isPopup()

Gets an indicator of whether the report should open in a separate window.

Returns:

True if the report should pop-up, otherwise false.

setPopup

public void setPopup(boolean popup)

Sets the target window popup property.

moveField

public void moveField(AimsField fld,
                      int toIndex)

Moves a field to the specified position in the fields list.

Parameters:

fld - The field to move.

toIndex - The location to move to.

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.