org.gvsig.fmap.dal.resource.spi

Class AbstractResource

java.lang.Object

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

All Implemented Interfaces:

Resource, ResourceProvider, Observable, WeakReferencingObservable

Direct Known Subclasses:

AbstractDBResourceBlocker, AbstractNonBlockingResource, FileResource, MultiResource, OGRResource

public abstract class AbstractResource
extends Object
implements ResourceProvider, WeakReferencingObservable

Base implementation for Resource

This implementation not define the Resource#begin() and Resource#end()

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	lock
protected Object	multiResourcelock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractResource(ResourceParameters parameters)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConsumer(ResourceConsumer consumer) Adds a consumer to this resource.
void	addObserver(Observer o)
void	addObservers(BaseWeakReferencingObservable observers)
void	closeRequest() If the resource is not in use, calling this method will send a close request to all consumers referencing this resource.
void	deleteObserver(Observer o)
void	deleteObservers()
Object	execute(ResourceAction action) Executes an action which uses the current Resource.
protected void	executeBegins()
protected void	executeEnds()
abstract Object	get() Returns the real resource represented by this object.
ResourceConsumer	getConsumerAt(int i)
int	getConsumersCount() Returns this resource's current number of consumers.
Object	getData() Returns a custom object containing extended data relative to this resource.
long	getLastTimeOpen() Returns the date and time in which this resource was opened for the last time.
long	getLastTimeUsed() Returns the date and time in which this resource was accessed for the last time.
abstract String	getName() Returns the name of the Resource.
ResourceParameters	getParameters() Returns the resource parameters.
boolean	inUse() Returns whether this resource is already in use by someone.
boolean	isOpen() Returns whether this resource is opened.
void	notifyChanges()
void	notifyClose()
void	notifyDispose()
protected void	notifyObserver(String type)
void	notifyOpen()
int	openCount() Returns the number of times this resource has been opened since it was created.
protected Object	performExecution(ResourceAction action)
void	prepare()
void	prepare(ResourceParameters params)
void	removeConsumer(ResourceConsumer consumer) Removes a consumer from this resource's consumer list.
void	setData(Object data) Sets a custom object as this resource's extended data.
protected void	updateLastTimeOpen()
protected void	updateLastTimeUsed()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.fmap.dal.resource.spi.ResourceProvider

isThis

Field Detail

lock

protected final Object lock

multiResourcelock

protected Object multiResourcelock

Constructor Detail

AbstractResource

protected AbstractResource(ResourceParameters parameters)
                    throws InitializeException

Throws:

InitializeException

Method Detail

updateLastTimeUsed

protected final void updateLastTimeUsed()

updateLastTimeOpen

protected final void updateLastTimeOpen()

getLastTimeOpen

public final long getLastTimeOpen()

Description copied from interface: Resource

Returns the date and time in which this resource was opened for the last time.

Specified by:

getLastTimeOpen in interface Resource

Returns:

date and time in which this resource was opened for the last time, in milliseconds.

getLastTimeUsed

public final long getLastTimeUsed()

Description copied from interface: Resource

Returns the date and time in which this resource was accessed for the last time.

Specified by:

getLastTimeUsed in interface Resource

Returns:

date and time in which this resource was accessed for the last time, in milliseconds.

getParameters

public final ResourceParameters getParameters()

Description copied from interface: Resource

Returns the resource parameters. These parameters contain all the necessary information to access the resource.

Specified by:

getParameters in interface Resource

Returns:

resource parameters.

prepare

public void prepare(ResourceParameters params)
             throws PrepareResourceException

Throws:

PrepareResourceException

prepare

public void prepare()
             throws PrepareResourceException

Specified by:

prepare in interface ResourceProvider

Throws:

PrepareResourceException

notifyOpen

public void notifyOpen()
                throws ResourceNotifyOpenException

Specified by:

notifyOpen in interface ResourceProvider

Throws:

ResourceNotifyOpenException

notifyClose

public void notifyClose()
                 throws ResourceNotifyCloseException

Specified by:

notifyClose in interface ResourceProvider

Throws:

ResourceNotifyCloseException

notifyChanges

public void notifyChanges()
                   throws ResourceNotifyChangesException

Specified by:

notifyChanges in interface ResourceProvider

Throws:

ResourceNotifyChangesException

isOpen

public boolean isOpen()

Description copied from interface: Resource

Returns whether this resource is opened.

Specified by:

isOpen in interface Resource

Returns:

true if this resource is opened, false if not.

openCount

public int openCount()

Description copied from interface: Resource

Returns the number of times this resource has been opened since it was created.

Specified by:

openCount in interface Resource

Returns:

number of times this resource has been opened since it was created.

addObserver

public void addObserver(Observer o)

Specified by:

addObserver in interface Observable

deleteObserver

public void deleteObserver(Observer o)

Specified by:

deleteObserver in interface Observable

deleteObservers

public void deleteObservers()

Specified by:

deleteObservers in interface Observable

addObservers

public final void addObservers(BaseWeakReferencingObservable observers)

addConsumer

public final void addConsumer(ResourceConsumer consumer)

Description copied from interface: Resource

Adds a consumer to this resource. This will create a weak reference to the consumer in this resource's consumer list.

Specified by:

addConsumer in interface Resource

Parameters:

consumer - the consumer that will be added to this resource's consumer list.

removeConsumer

public final void removeConsumer(ResourceConsumer consumer)

Description copied from interface: Resource

Removes a consumer from this resource's consumer list.

Specified by:

removeConsumer in interface Resource

Parameters:

consumer - the consumer that will be removed.

getConsumersCount

public int getConsumersCount()

Description copied from interface: Resource

Returns this resource's current number of consumers.

Specified by:

getConsumersCount in interface Resource

Returns:

current number of consumers of this resource.

getConsumerAt

public ResourceConsumer getConsumerAt(int i)

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

Throws:

ResourceException

setData

public void setData(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

Parameters:

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

getData

public 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

Returns:

data related to this resource

notifyObserver

protected void notifyObserver(String type)

notifyDispose

public void notifyDispose()
                   throws ResourceNotifyDisposeException

Specified by:

notifyDispose in interface ResourceProvider

Throws:

ResourceNotifyDisposeException

inUse

public final boolean inUse()

Description copied from interface: Resource

Returns whether this resource is already in use by someone.

Specified by:

inUse in interface Resource

Returns:

true if this resource is in use, false if not.

execute

public Object execute(ResourceAction action)
               throws ResourceExecuteException

Description copied from interface: Resource

Executes an action which uses the current Resource.

Specified by:

execute in interface Resource

Returns:

the action return value

Throws:

ResourceExecuteException

performExecution

protected Object performExecution(ResourceAction action)
                           throws Exception

Throws:

Exception

executeBegins

protected final void executeBegins()

executeEnds

protected final void executeEnds()

getName

public abstract String getName()
                        throws AccessResourceException

Returns the name of the Resource.

Specified by:

getName in interface Resource

Returns:

resource's name

Throws:

AccessResourceException - if there is an error while accessing the resource

get

public abstract Object get()
                    throws AccessResourceException

Returns the real resource represented by this object.

Specified by:

get in interface Resource

Returns:

an object that represents the resource.

Throws:

AccessResourceException - if there is an error while accessing the resource