com.sabratec.applinx.presentation.queries

Class GXAreaQuery

java.lang.Object

com.sabratec.applinx.presentation.queries.GXAreaQuery

All Implemented Interfaces:

GXITagQuery

public class GXAreaQuery
extends Object
implements GXITagQuery

This query returns tags in the given area. The query can be either row based by using the constructor GXAreaQuery(int, int) or rectangle based GXAreaQuery(GXRectangle, int, boolean)

See Also:

GXIScreenTagModel.executeQuery(GXITagQuery)

Field Summary

Fields

Modifier and Type	Field and Description
static int	RETRIEVE_INSIDE_AREA Indicates retrieval of tags from inside the area.
static int	RETRIEVE_OUTSIDE_AREA Indicates retrieval of tags from outside the area.

Constructor Summary

Constructors

Constructor and Description
GXAreaQuery() Creates an empty instance.
GXAreaQuery(GXRectangle area, int retrievalMode, boolean entireTag) Creates an instance of a rectanglar area query.
GXAreaQuery(int startRow, int endRow) Creates an instance of a rectangular area query using to start and end rows.

Method Summary

Modifier and Type	Method and Description
GXTagList	find(GXIScreenTagModel screenModel) Only tags that have host-screen positions will be returned.
void	setArea(GXRectangle area) Sets the rectangular area according to which tags will be retrieved.
void	setEntireTag(boolean entireTag) Defines whether tags that intersect with the area's frame will be considered as meeting the criteria.
void	setRetrievalMode(int retrievalMode) Sets the retrieval mode, either tags inside or outside the area.
void	setRowRange(int startRow, int endRow) Sets the rectangular area using the start and end rows.

Methods inherited from class java.lang.Object

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

Field Detail

RETRIEVE_INSIDE_AREA

public static int RETRIEVE_INSIDE_AREA

Indicates retrieval of tags from inside the area. This is the default value.

RETRIEVE_OUTSIDE_AREA

public static int RETRIEVE_OUTSIDE_AREA

Indicates retrieval of tags from outside the area.

Constructor Detail

GXAreaQuery

public GXAreaQuery()

Creates an empty instance.

GXAreaQuery

public GXAreaQuery(GXRectangle area,
                   int retrievalMode,
                   boolean entireTag)

Creates an instance of a rectanglar area query.

Parameters:

area - The rectangular area according which determine tags will be retrieved

retrievalMode - indicates retrieval of tags from either inside or outside the area

entireTag - indicates whether tags that intersect with the area's frame will be considered as a matching tags

GXAreaQuery

public GXAreaQuery(int startRow,
                   int endRow)

Creates an instance of a rectangular area query using to start and end rows. The criteria is inclusive, i.e. tags which are positioned in the rows themselves will also be retrieved.

Parameters:

startRow - the row where the range starts, inclusive.

endRow - the row where the range ends, inclusive.

Method Detail

setArea

public void setArea(GXRectangle area)

Sets the rectangular area according to which tags will be retrieved.

Parameters:

area - the rectangular area according to which tags will be retrieved

setRowRange

public void setRowRange(int startRow,
                        int endRow)

Sets the rectangular area using the start and end rows. The criteria is inclusive, i.e. tags which are positioned in the rows themselves will also be retrieved.

Parameters:

startRow - the row where the range starts (including this row).

endRow - the row where the range ends (including this row).

setRetrievalMode

public void setRetrievalMode(int retrievalMode)

Sets the retrieval mode, either tags inside or outside the area.

Parameters:

retrievalMode - indicates retrieval of tags from either inside or outside the area

See Also:

RETRIEVE_INSIDE_AREA, RETRIEVE_OUTSIDE_AREA

setEntireTag

public void setEntireTag(boolean entireTag)

Defines whether tags that intersect with the area's frame will be considered as meeting the criteria.

Parameters:

entireTag - true if the entire tag has to be contained in the area

find

public GXTagList find(GXIScreenTagModel screenModel)

Only tags that have host-screen positions will be returned.

Specified by:

find in interface GXITagQuery

Parameters:

screenModel - The screen model that the query is performed against

Returns:

All tags meeting the query. If there are no tags that meet the query, an empty list is returned