org.gvsig.metadata
Interface DefinitionsMap

All Superinterfaces:

Map

public interface DefinitionsMap
extends Map

This is the intermediary of the ImportExport module, which enables to have a disposable iterator of a list of DynStructs. It also permits to obtain another disposable iterator of the related DynFields based on a given DynStruct. It extends from a Map.

Version:

$Id$

Author:

gvSIG Team, cmartin

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

void	add(DynStruct newDefinition) Adds a definition to the list
void	addAll(Map map)
Iterator	childrenIterator(DynStruct parentDefinition) Returns a list iteration containing the current children element definitions of a given parentDefinition.
DisposableIterator	disposableIterator() Returns a disposable list iteration containing the current elements of the list.
DisposableIterator	dynFieldsIterator(DynStruct definition) Returns a disposable list iteration containing DynFields based on a given definition ( DynStruct ).
List	getChildren(DynStruct definition) Returns a list containing children definitions (DynStructs) based on a given definition.
boolean	hasDefinition(DynStruct definition) Determines if this definition is already included.
Iterator	iterator() Returns a list containing definitions ( DynStruct ), which are disposable.
Iterator	parentsIterator(DynStruct childDefinition) Returns a list iteration containing the current parent element definitions of a given childDefinition.
void	remove(DynStruct definition) Removes a definition from the list
void	save() Saves the current Metadata elements of the list.
void	setHierarchyDefinitions(Map userDefs, Map hierarchyDefs) Sets the current user definitions linked to the current hierarchy definitions.
int	size() Retrieves the size of the list of elements.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, values

Method Detail

remove

void remove(DynStruct definition)

Removes a definition from the list

Parameters:

definition - the definition to be removed.

add

void add(DynStruct newDefinition)

Adds a definition to the list

Parameters:

definition - the definition to be added.

addAll

void addAll(Map map)

hasDefinition

boolean hasDefinition(DynStruct definition)

Determines if this definition is already included.

Parameters:

definition - the current definition to be checked.

Returns:

true if the definition is contained, false otherwise.

save

void save()

Saves the current Metadata elements of the list.

size

int size()

Retrieves the size of the list of elements.

Specified by:

size in interface Map

setHierarchyDefinitions

void setHierarchyDefinitions(Map userDefs,
                             Map hierarchyDefs)

Sets the current user definitions linked to the current hierarchy definitions.

Parameters:

userDefs - the user Definitions

hierarchyDefs - the hierarchy Definitions

iterator

Iterator iterator()

Returns a list containing definitions ( DynStruct ), which are disposable.

Returns:

the disposable DynStructs iterator.

dynFieldsIterator

DisposableIterator dynFieldsIterator(DynStruct definition)

Returns a disposable list iteration containing DynFields based on a given definition ( DynStruct ).

Parameters:

definition - the DynStruct definition from which to obtain the associated DynFields.

Returns:

the disposable DynFields iterator.

getChildren

List getChildren(DynStruct definition)

Returns a list containing children definitions (DynStructs) based on a given definition.

Parameters:

definition - the DynStruct definition from which to obtain the associated children.

Returns:

the disposable DynFields iterator.

disposableIterator

DisposableIterator disposableIterator()

Returns a disposable list iteration containing the current elements of the list.

Returns:

the disposable DynFields iterator.

parentsIterator

Iterator parentsIterator(DynStruct childDefinition)

Returns a list iteration containing the current parent element definitions of a given childDefinition.

Parameters:

childDefinition -

Returns:

the parent definitions' iterator.

childrenIterator

Iterator childrenIterator(DynStruct parentDefinition)

Returns a list iteration containing the current children element definitions of a given parentDefinition.

Returns:

the parent definitions' iterator.