com.moximedia.aims
Class SqlQuery

java.lang.Object
  com.moximedia.aims.SqlQuery

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SqlQuery

extends java.lang.Object

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

Author:

Doug Cates

See Also:

Serialized Form

Constructor Summary

SqlQuery()
Creates a new instance of SqlQuery

Method Summary

void	addQueryColumn(SqlColumn column)
void	addRelateColumn(SqlColumn column) Adds a relate column to the SqlQuery.
java.lang.Object	clone()
SqlQuery	getCopy()
java.lang.String	getDescription() Gets the name of the SqlQuery, which appears as a title on the identify and select reports.
java.util.HashSet	getExamples(SqlConnections connections, SqlColumn column)
java.lang.String	getExamplesSqlStatement(SqlColumn column) Gets the SQL statement after replacing parameters.
java.lang.String	getFilterWhereExpression(SqlConnections connections, java.lang.String sqlWhereExpression)
boolean	getMaximumResultsExceeded() Returns an indicator of whether the maximum number of results has been exceeded.
int	getObjectId() Returns the IMF internal object id for this object, guaranteed to be different from any other oobject of this type in the currently running application.
java.lang.String	getQueryBuilderQueryString()
SqlColumn	getQueryColumnByObjectId(int objectId)
java.util.ArrayList	getQueryColumns()
java.lang.String	getSqlStatement(java.lang.String sqlWhereExpression)
void	query()
void	setDescription(java.lang.String description) Sets the name of the SqlQuery, which appears as a title on the identify and select reports.
void	setExamplesMaximumResults(int maxResults)
void	setMaximumResults(int maxResults)
void	setQueryBuilderQueryString(java.lang.String query)
void	setRecordset(AimsRecordset rs) Sets the feature layer recordset for use in retrieving values contained in the feature attributes.
void	setXmlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlQuery

public SqlQuery()

Creates a new instance of SqlQuery

Method Detail

clone

public java.lang.Object clone()

getCopy

public SqlQuery getCopy()

getObjectId

public int getObjectId()

Returns the IMF internal object id for this object, guaranteed to be different from any other oobject of this type in the currently running application.

Returns:

The internal id for this object.

addRelateColumn

public void addRelateColumn(SqlColumn column)

Adds a relate column to the SqlQuery. The key column object references the field name in the feature layer's recordset, and the associated column in the external database used to join the tables.

Parameters:

column - The SqlColumn object.

addQueryColumn

public void addQueryColumn(SqlColumn column)

getQueryColumns

public java.util.ArrayList getQueryColumns()

getQueryColumnByObjectId

public SqlColumn getQueryColumnByObjectId(int objectId)

setExamplesMaximumResults

public void setExamplesMaximumResults(int maxResults)

getMaximumResultsExceeded

public boolean getMaximumResultsExceeded()

Returns an indicator of whether the maximum number of results has been exceeded.

Returns:

True if the maximum number of results has been exceeded, otherwise false.

getDescription

public java.lang.String getDescription()

Gets the name of the SqlQuery, which appears as a title on the identify and select reports.

Returns:

The name of the report.

setDescription

public void setDescription(java.lang.String description)

Sets the name of the SqlQuery, which appears as a title on the identify and select reports.

setMaximumResults

public void setMaximumResults(int maxResults)

setRecordset

public void setRecordset(AimsRecordset rs)

Sets the feature layer recordset for use in retrieving values contained in the feature attributes.

Parameters:

rs - The layer's recordset object.

getExamples

public java.util.HashSet getExamples(SqlConnections connections,
                                     SqlColumn column)

getExamplesSqlStatement

public java.lang.String getExamplesSqlStatement(SqlColumn column)

Gets the SQL statement after replacing parameters.

Returns:

The SQL statement.

getSqlStatement

public java.lang.String getSqlStatement(java.lang.String sqlWhereExpression)

getFilterWhereExpression

public java.lang.String getFilterWhereExpression(SqlConnections connections,
                                                 java.lang.String sqlWhereExpression)

query

public void query()

setXmlAttribute

public void setXmlAttribute(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 XML element tag containing this attribute.

name - The XML attribute name.

value - The XML attribute value.

getQueryBuilderQueryString

public java.lang.String getQueryBuilderQueryString()

setQueryBuilderQueryString

public void setQueryBuilderQueryString(java.lang.String query)