com.moximedia.aims
Class AimsLayerGroups

java.lang.Object
  extended byjava.util.AbstractCollection
      extended byjava.util.AbstractList
          extended byjava.util.ArrayList
              extended bycom.moximedia.aims.AimsLayerGroups
All Implemented Interfaces:
AimsObject, java.lang.Cloneable, java.util.Collection, java.util.List, java.util.RandomAccess, java.io.Serializable

public class AimsLayerGroups
extends java.util.ArrayList
implements AimsObject, java.io.Serializable

Author:
Doug Cates - www.moximedia.com
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.AbstractList
modCount
 
Fields inherited from interface com.moximedia.aims.AimsObject
OBJECT_TYPE_ACETATE_LAYER, OBJECT_TYPE_FEATURE_LAYER, OBJECT_TYPE_FOLDER, OBJECT_TYPE_FOLDERS, OBJECT_TYPE_GROUP, OBJECT_TYPE_GROUPS, OBJECT_TYPE_IMAGE_LAYER, OBJECT_TYPE_WMS_LAYER
 
Constructor Summary
AimsLayerGroups()
          Creates new AimsLayerGroups
 
Method Summary
 void addLayerGroup(AimsLayerGroup group)
          Adds an AimsLayerGroup to the collection.
 AimsLayerGroups getGroupsContainingLayer(AimsLayer layer)
          Returns an new AimsLayerGroups object containing an array of AimsLayerGroup objects that contain the specified layer.
 AimsLayerGroup getLayerGroup(java.lang.String groupNameOrId)
          Returns an AimsLayerGroup matching a name or ID, or null if not found.
 AimsLayerGroup getLayerGroupByObjectId(int objectId)
          Returns an AimsLayerGroup matching an object ID, or null if not found.
 int getObjectType()
          Gets the type of object this is.
 void removeLayer(int objectId)
          Removes the layer with the specified object ID from this group.
 
Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, removeRange, set, size, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
containsAll, remove, removeAll, retainAll, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
containsAll, equals, hashCode, iterator, listIterator, listIterator, remove, removeAll, retainAll, subList
 

Constructor Detail

AimsLayerGroups

public AimsLayerGroups()
Creates new AimsLayerGroups

Method Detail

addLayerGroup

public void addLayerGroup(AimsLayerGroup group)
Adds an AimsLayerGroup to the collection.


getLayerGroupByObjectId

public AimsLayerGroup getLayerGroupByObjectId(int objectId)
Returns an AimsLayerGroup matching an object ID, or null if not found.

Parameters:
objectId - The object ID of the AimsLayerGroup
Returns:
The Layer Group matching the search parameter, or null if a matching Layer Group is not found

getLayerGroup

public AimsLayerGroup getLayerGroup(java.lang.String groupNameOrId)
Returns an AimsLayerGroup matching a name or ID, or null if not found.

Parameters:
groupNameOrId - name or ID of the AimsLayerGroup
Returns:
The Layer Group matching the search parameter, or null if a matching Layer Group is not found

getGroupsContainingLayer

public AimsLayerGroups getGroupsContainingLayer(AimsLayer layer)
Returns an new AimsLayerGroups object containing an array of AimsLayerGroup objects that contain the specified layer.

Parameters:
layer - The layer to find.
Returns:
The AimsLayerGroups object containing matching groups.

removeLayer

public void removeLayer(int objectId)
Removes the layer with the specified object ID from this group.

Parameters:
objectId - The layer's objectId.

getObjectType

public int getObjectType()
Gets the type of object this is.

Specified by:
getObjectType in interface AimsObject
Returns:
The enumerated value.


Internet Mapping Framework for ArcIMS Java Object Model API (v5.1.00)
Copyright © 2006 Moxi Media Inc. and Province of British Columbia. All Rights Reserved.