All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.las.ogdi.OGDIDictionaryItem 

java.lang.Object
   |
   +----com.las.ogdi.OGDIDictionaryItem
public class OGDIDictionaryItem
extends Object
The DictionaryItem class defines a dictionary item. The structure is dependent on the datastore driver. A dictionary item is a node in a tree. It can have children. If it has no child then it is considered a "leaf".

Version:
1.0
Author:
Las Inc.
See Also:
OGDIDictionary

Constructor Index

o OGDIDictionaryItem(String, String, String, int, String)
Creates a DictionaryItem instance.

Method Index

o add(OGDIDictionaryItem)
Adds a child item to this dictionary item.
o getChildren()
Returns the list of children in an Enumeration for a family.
o getChildren(OGDIFamily)
Returns the list of children in an Enumeration for a family.
o getDescriptor()
Returns the descriptor of the token.
o getFamily()
Gets the family of that dictionary item.
o getLevel()
Gets the level of that dictionary item.
o getMetadata(int)
Gets the metainformation about the datasource.
o getName()
Returns the name of the token, that is the String that will be used to replace the token at it's place in the Syntax Model.
o remove(OGDIDictionaryItem)
Removes a child item from this dictionary item.
o toString()
Gets the complete dictionary item description.

Constructors

o OGDIDictionaryItem 
 public OGDIDictionaryItem(String name,
                           String covinfo,
                           String family,
                           int level,
                           String descriptor)
Creates a DictionaryItem instance.

Parameters:
name - the specific name of the item
covinfo - gives more information about that item
family - the family of that item
descriptor - comments about the item
Returns:
no return
Throws: IllegalArgumentException
if a parameter is illegal

Methods

o getChildren 
 public Enumeration getChildren()
Returns the list of children in an Enumeration for a family. Elements of the Enumeration are instances of OGDIDictionaryItem.

Parameters:
no - parameter
Returns:
the enumeration of dictionary items who are children
o getChildren 
 public Enumeration getChildren(OGDIFamily family)
Returns the list of children in an Enumeration for a family. Elements of the Enumeration are instances of OGDIDictionaryItem.

Parameters:
family - the family of the coverages enumerated
Returns:
the enumeration of dictionary items who are children
Throws: IllegalArgumentException
if the family is illegal
o add 
 public void add(OGDIDictionaryItem item)
Adds a child item to this dictionary item.

Parameters:
item - the item
Returns:
no return
Throws: IllegalArgumentException
if the item is illegal
o remove 
 public void remove(OGDIDictionaryItem item)
Removes a child item from this dictionary item.

Parameters:
item - the item
Returns:
no return
Throws: IllegalArgumentException
if could not to remove an item
o getName 
 public String getName()
Returns the name of the token, that is the String that will be used to replace the token at it's place in the Syntax Model.

Parameters:
no - param
Returns:
the name
Throws: no
exception
o getMetadata 
 public String getMetadata(int level)
Gets the metainformation about the datasource.

Parameters:
level - the level of detail of the metadata returned (0 is minimum)
Returns:
a string of metainformation dependent on the driver type
Throws: no
exception
o getFamily 
 public OGDIFamily getFamily()
Gets the family of that dictionary item.

Parameters:
no - parameter
Returns:
a family
Throws: no
exception
o getLevel 
 public int getLevel()
Gets the level of that dictionary item.

Parameters:
no - parameter
Returns:
a level (0 is a leaf)
Throws: no
exception
o getDescriptor 
 public String getDescriptor()
Returns the descriptor of the token.

Parameters:
no - param
Returns:
the descriptor
Throws: no
exception
o toString 
 public String toString()
Gets the complete dictionary item description.

Parameters:
no - parameter
Returns:
the item name, family, level, description and children as string
Throws: no
exception
Overrides:
toString in class Object 
All Packages  Class Hierarchy  This Package  Previous  Next  Index