Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.instance.model
Interface InstanceCollection

All Superinterfaces:
InstanceResolver
All Known Implementing Classes:
BrowseOrientInstanceCollection, DefaultInstanceCollection, FilteredInstanceCollection, GmlInstanceCollection, MultiInstanceCollection, ShapesInstanceCollection

public interface InstanceCollection
extends InstanceResolver

Instance collection interface

Author:
Simon Templer
Partner:
01 / Fraunhofer Institute for Computer Graphics Research

Field Summary
static int UNKNOWN_SIZE
          Constant for unknown collection size
 
Method Summary
 boolean hasSize()
          States if the collection has a known size.
 boolean isEmpty()
          States if the collection has no instances.
 ResourceIterator<Instance> iterator()
          Get an iterator over all instances contained in the collection.
 InstanceCollection select(Filter filter)
          Select the instances in the collection, matching the given filter.
 int size()
          Get the collection size if known.
 
Methods inherited from interface eu.esdihumboldt.hale.common.instance.model.InstanceResolver
getInstance, getReference
 

Field Detail

UNKNOWN_SIZE

static final int UNKNOWN_SIZE
Constant for unknown collection size

See Also:
Constant Field Values
Method Detail

iterator

ResourceIterator<Instance> iterator()
Get an iterator over all instances contained in the collection. The iterator must be disposed after use (using ResourceIterator.close()).

Returns:
an iterator over the instances

hasSize

boolean hasSize()
States if the collection has a known size.

Returns:
if the collection size is known

size

int size()
Get the collection size if known.

Returns:
the collection size or UNKNOWN_SIZE
See Also:
hasSize()

isEmpty

boolean isEmpty()
States if the collection has no instances. This must return a valid value even if hasSize() returns false.

Returns:
if the collection is empty

select

InstanceCollection select(Filter filter)
Select the instances in the collection, matching the given filter.

Parameters:
filter - the instance filter
Returns:
the instance collection representing the selection

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d