com.isti.util.gis
Interface IstiRegionMgrIntf

All Known Implementing Classes:
IstiRegionMgrImpl

public interface IstiRegionMgrIntf

Interface IstiRegionMgrIntf defines methods for managing a collection of GIS regions. One main collection and any number of auxiliary collections are supported.


Method Summary
 java.lang.String checkGenerateRegionName(java.lang.String baseNameStr)
          Appends a numeric-suffix value to the given name string such that the result name does not duplicate any existing region name.
 java.util.List getAllRegionNamesList()
          Returns a list of region-name strings, with an entry for each current global and recipient region.
 int getAllRegionsCount()
          Returns a count of the total number of current global and recipient regions.
 java.util.Vector getAllRegionStrsList()
          Returns a list of region strings, with an entry for each current global and recipient region.
 IstiRegion[] getMainRegionObjs()
          Returns the main collection of regions.
 java.lang.String getMainRegionsStr()
          Returns the main collection of regions.
 void setMainRegionsStr(java.lang.String regionsStr)
          Sets the main collection of regions.
 void updateAuxRegionsEntry(java.lang.Object keyObj, IstiRegion[] regionsArr)
          Updates an auxiliary region.
 

Method Detail

setMainRegionsStr

void setMainRegionsStr(java.lang.String regionsStr)
Sets the main collection of regions.

Parameters:
regionsStr - string representation of the regions to be set.

getMainRegionsStr

java.lang.String getMainRegionsStr()
Returns the main collection of regions.

Returns:
A string representation of the regions.

getMainRegionObjs

IstiRegion[] getMainRegionObjs()
Returns the main collection of regions.

Returns:
An array containing the region objects.

updateAuxRegionsEntry

void updateAuxRegionsEntry(java.lang.Object keyObj,
                           IstiRegion[] regionsArr)
Updates an auxiliary region. If a region array exists for the given key then it is replaced.

Parameters:
keyObj - keyObj object associated with region.
regionsArr - array to region objects to be entered, or null or empty array to delete the entry for the given key.

getAllRegionsCount

int getAllRegionsCount()
Returns a count of the total number of current global and recipient regions.

Returns:
A count of the total number of current global and recipient regions.

getAllRegionStrsList

java.util.Vector getAllRegionStrsList()
Returns a list of region strings, with an entry for each current global and recipient region.

Returns:
A new Vector object containing the region strings (empty list if no regions are available).

getAllRegionNamesList

java.util.List getAllRegionNamesList()
Returns a list of region-name strings, with an entry for each current global and recipient region.

Returns:
A new Vector object containing the region-name strings (empty list if no regions are available).

checkGenerateRegionName

java.lang.String checkGenerateRegionName(java.lang.String baseNameStr)
Appends a numeric-suffix value to the given name string such that the result name does not duplicate any existing region name.

Parameters:
baseNameStr - base name string to use.
Returns:
A new region-name string.