com.moximedia.ows
Class Folders

java.lang.Object
  java.util.AbstractCollection
      java.util.AbstractList
          java.util.ArrayList
              com.moximedia.ows.Folders

All Implemented Interfaces:

java.lang.Cloneable, java.util.Collection, java.util.List, java.util.RandomAccess, java.io.Serializable

public class Folders

extends java.util.ArrayList

implements java.io.Serializable

Author:

jdc

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Folders()
Create a new Folders object.

Method Summary

void	addFolder(Folder folder) Adds a folder to the folders collection.
Folder	getFolderByName(java.lang.String name) Gets the folder with the specified name.
Folder	getFolderByObjectId(int objectId) Gets the folder with the specified object id.
LayerGroup	getLayerGroupByObjectId(int objectId) Gets the layer group with the specified object id.
boolean	hasLayerListLegends(double scale) Returns an indicator of whether this folder or any subfolders have layer list legends for the specified scale.
void	setLevel(int level) Sets the nesting level of the folders object.

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

Folders

public Folders()

Create a new Folders object.

Method Detail

setLevel

public void setLevel(int level)

Sets the nesting level of the folders object.

Parameters:

level - The level, 0 to 3

addFolder

public void addFolder(Folder folder)

Adds a folder to the folders collection.

Parameters:

folder - A Folder object to add to the end of the folders collection.

getFolderByName

public Folder getFolderByName(java.lang.String name)

Gets the folder with the specified name.

Parameters:

name - The folder name.

Returns:

The first folder matching the name, or null if not found.

getFolderByObjectId

public Folder getFolderByObjectId(int objectId)

Gets the folder with the specified object id. The object id is a unique numeric value set by IMF.

Parameters:

objectId - The folder object id.

Returns:

The first folder matching the object id, or null if not found.

getLayerGroupByObjectId

public LayerGroup getLayerGroupByObjectId(int objectId)

Gets the layer group with the specified object id. The object id is a unique numeric value set by IMF.

Parameters:

objectId - The layer group object id.

Returns:

The first layer group matching the object id, or null if not found.

hasLayerListLegends

public boolean hasLayerListLegends(double scale)

Returns an indicator of whether this folder or any subfolders have layer list legends for the specified scale.

Parameters:

scale - The scale to check for.

Returns:

True if any legends, otherwise false.