org.gvsig.fmap.dal.resource.spi

Class MultiResource

java.lang.Object

org.gvsig.fmap.dal.resource.spi.AbstractResource

org.gvsig.fmap.dal.resource.spi.MultiResource

All Implemented Interfaces:

Resource, ResourceProvider, Observable, WeakReferencingObservable

public class MultiResource
extends AbstractResource

Resource implementation which is able to show an unique interface to a group of Resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESCRIPTION
static java.lang.String	TYPE_NAME

Fields inherited from class org.gvsig.fmap.dal.resource.spi.AbstractResource

lock, multiResourcelock

Constructor Summary

Constructors

Constructor and Description
MultiResource(MultiResourceParameters parameters) Creates a new MultiResource from the given parameters.

Method Summary

Modifier and Type	Method and Description
void	addMultiResourceConsumer(ResourceConsumer consumer)
void	addResource(ResourceParameters parameters, boolean defaultResource) Adds a new ResourceProvider to the list of Resources managed by this group.
void	addResource(java.lang.String name, java.lang.Object[] params, boolean defaultResource) Adds a new ResourceProvider to the list of Resources managed by this group.
void	closeRequest() If the resource is not in use, calling this method will send a close request to all consumers referencing this resource.
java.lang.Object	execute(ResourceAction action) Locks the multiresource components to avoid another concurrent modification
void	frozen() Blocks the adding methods.
java.lang.Object	get() Returns the real resource represented by this object.
java.lang.Object	getData() Returns a custom object containing extended data relative to this resource.
java.lang.String	getName() Returns the name of the Resource.
boolean	isThis(ResourceParameters parameters)
void	notifyChanges()
void	notifyClose()
void	notifyDispose()
void	notifyOpen()
void	prepare()
void	setData(java.lang.Object data) Sets a custom object as this resource's extended data.
java.lang.String	toString()

Methods inherited from class org.gvsig.fmap.dal.resource.spi.AbstractResource

addConsumer, addObserver, addObservers, deleteObserver, deleteObservers, executeBegins, executeEnds, getConsumerAt, getConsumersCount, getLastTimeOpen, getLastTimeUsed, getParameters, inUse, isOpen, notifyObserver, openCount, performExecution, prepare, removeConsumer, updateLastTimeOpen, updateLastTimeUsed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_NAME

public static final java.lang.String TYPE_NAME

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

MultiResource

public MultiResource(MultiResourceParameters parameters)
              throws InitializeException

Creates a new MultiResource from the given parameters.

Parameters:

parameters - to create the resource from

Throws:

InitializeException - if there is an error creating the resource

Method Detail

addResource

public void addResource(ResourceParameters parameters,
                        boolean defaultResource)
                 throws InitializeException

Adds a new ResourceProvider to the list of Resources managed by this group.

Parameters:

parameters - to create the resource from

defaultResource - if the added resource is to be used as the multi resource default one

Throws:

InitializeException - if there is an error adding the resource

addResource

public void addResource(java.lang.String name,
                        java.lang.Object[] params,
                        boolean defaultResource)
                 throws InitializeException

Adds a new ResourceProvider to the list of Resources managed by this group.

Parameters:

name - of the resource to add

params - parameters to create the resource with

defaultResource - if the added resource is to be used as the multi resource default one

Throws:

InitializeException - if there is an error adding the resource

isThis

public boolean isThis(ResourceParameters parameters)
               throws ResourceException

Throws:

ResourceException

notifyChanges

public void notifyChanges()
                   throws ResourceNotifyChangesException

Specified by:

notifyChanges in interface ResourceProvider

Overrides:

notifyChanges in class AbstractResource

Throws:

ResourceNotifyChangesException

notifyClose

public void notifyClose()
                 throws ResourceNotifyCloseException

Specified by:

notifyClose in interface ResourceProvider

Overrides:

notifyClose in class AbstractResource

Throws:

ResourceNotifyCloseException

notifyDispose

public void notifyDispose()
                   throws ResourceNotifyDisposeException

Specified by:

notifyDispose in interface ResourceProvider

Overrides:

notifyDispose in class AbstractResource

Throws:

ResourceNotifyDisposeException

notifyOpen

public void notifyOpen()
                throws ResourceNotifyOpenException

Specified by:

notifyOpen in interface ResourceProvider

Overrides:

notifyOpen in class AbstractResource

Throws:

ResourceNotifyOpenException

prepare

public void prepare()
             throws PrepareResourceException

Specified by:

prepare in interface ResourceProvider

Overrides:

prepare in class AbstractResource

Throws:

PrepareResourceException

closeRequest

public void closeRequest()
                  throws ResourceException

Description copied from interface: Resource

If the resource is not in use, calling this method will send a close request to all consumers referencing this resource. If the resource is in use, calling this method will do nothing.

Specified by:

closeRequest in interface Resource

Overrides:

closeRequest in class AbstractResource

Throws:

ResourceException

get

public java.lang.Object get()
                     throws AccessResourceException

Description copied from class: AbstractResource

Returns the real resource represented by this object.

Specified by:

get in interface Resource

Specified by:

get in class AbstractResource

Returns:

an object that represents the resource.

Throws:

AccessResourceException - if there is an error while accessing the resource

getData

public java.lang.Object getData()

Description copied from interface: Resource

Returns a custom object containing extended data relative to this resource. This is part of a simple mechanism to allow passing further data to the resource that may be necessary for optimal treatment.

Specified by:

getData in interface Resource

Overrides:

getData in class AbstractResource

Returns:

data related to this resource

getName

public java.lang.String getName()
                         throws AccessResourceException

Description copied from class: AbstractResource

Returns the name of the Resource.

Specified by:

getName in interface Resource

Specified by:

getName in class AbstractResource

Returns:

resource's name

Throws:

AccessResourceException - if there is an error while accessing the resource

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setData

public void setData(java.lang.Object data)

Description copied from interface: Resource

Sets a custom object as this resource's extended data. This is part of a simple mechanism to allow passing further data to the resource that may be necessary for optimal treatment.

Specified by:

setData in interface Resource

Overrides:

setData in class AbstractResource

Parameters:

data - a custom object containing data related to this resource.

frozen

public void frozen()

Blocks the adding methods. It is called when all their resources components are added.

execute

public java.lang.Object execute(ResourceAction action)
                         throws ResourceExecuteException

Locks the multiresource components to avoid another concurrent modification

Specified by:

execute in interface Resource

Overrides:

execute in class AbstractResource

Returns:

the action return value

Throws:

ResourceExecuteException

addMultiResourceConsumer

public void addMultiResourceConsumer(ResourceConsumer consumer)