Interface WritableAggregate

All Superinterfaces:

Aggregate, Resource

public interface WritableAggregate
extends Aggregate

An Aggregate with writing capabilities. Writable­Aggregate inherits the reading capabilities from its parent and adds the capabilities to add or remove resources.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface Resource

Resource.File­Set

Modifier and Type	Interface	Description
static class	Resource.File­Set	Paths to the files potentially used by the enclosing resource.

Method Summary

Modifier and Type	Method	Description
Resource	add(Resource resource)	Adds a new Resource in this Aggregate.
void	remove(Resource resource)	Removes a Resource from this Aggregate.

Methods inherited from interface Aggregate

components

Modifier and Type	Method	Description
Collection<? extends Resource>	components()	Returns the children resources of this aggregate.

Methods inherited from interface Resource

add­Listener, get­File­Set, get­Identifier, get­Metadata, remove­Listener

Modifier and Type	Method	Description
default <T extends Store­Event> void	add­Listener(Class<T> event­Type, Store­Listener<? super T> listener)	Registers a listener to notify when the specified kind of event occurs in this resource or in children.
default Optional<Resource.File­Set>	get­File­Set()	Gets the paths to the files potentially used by this resource.
default Optional<Generic­Name>	get­Identifier()	Returns the resource persistent identifier.
Metadata	get­Metadata()	Returns information about this resource.
default <T extends Store­Event> void	remove­Listener(Class<T> event­Type, Store­Listener<? super T> listener)	Unregisters a listener previously added to this resource for the given type of events.

Method Details

add

Resource add(Resource resource)
      throws DataStoreException

Adds a new Resource in this Aggregate. The given Resource may be copied, and the effectively added resource returned. The effectively added resource may differ from the given resource in many aspects. The possible changes may include the followings but not only:

• types and properties names
• Coordinate­Reference­System
• Metadata

Data transformation

Copying information between stores may produce differences in many aspects. The range of changes depends both on the original Resource structure and the target Resource structure. If the differences are too large, then this Aggregate may throw an exception.

Parameters:

resource - the resource to copy in this Aggregate.

Returns:

the effectively added resource. May be resource itself if it has been added verbatim.

Throws:

Data­Store­Exception - if the given resource cannot be stored in this Aggregate.

remove

void remove(Resource resource)
     throws DataStoreException

Removes a Resource from this Aggregate. The given resource should be one of the instances returned by Aggregate.components(). This operation is destructive in two aspects:

• The Resource and it's data will be deleted from the Data­Store.
• The given resource may become invalid and should not be used anymore after this method call.

Parameters:

resource - child resource to remove from this Aggregate.

Throws:

Data­Store­Exception - if the given resource could not be removed.