com.github.wuic.nut

Class NutsHeap

java.lang.Object

com.github.wuic.nut.NutsHeap

All Implemented Interfaces:

NutDaoListener, HeapListener

public class NutsHeap
extends Object
implements NutDaoListener, HeapListener

This class represents a set of nuts. Each Nut is built thanks to an associated NutDao which only needs a particular path to create it.

A path is an abstract location of one to many nuts because it could be a regular expression. It is relative to the base path of the NutDao.

All the paths must refer to the same type fo path (CSS, JS, etc).

Since:

0.1.0

Version:

1.7

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NutsHeap.ListenerHolder The NutsHeap is a NutDaoListener registered in the NutDao.

Constructor Summary

Constructors

Constructor and Description
NutsHeap(NutsHeap other) Builds a heap by copy.
NutsHeap(Object factoryObject, List<String> pathsList, boolean isDisposable, NutDao theNutDao, String heapId, NutsHeap... heaps) Builds a new NutsHeap.
NutsHeap(Object factoryObject, List<String> pathsList, NutDao theNutDao, String heapId, NutsHeap... heaps) Builds a heap which is not disposable.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCreate(String pattern, String path) Refers a path as a resource created by this heap for the given pattern.
void	addObserver(HeapListener listener) Observes all the nuts in this heap with the given listener.
void	checkFiles(ProcessContext processContext) Checks that the NutType and the paths list of this heap are not null.
boolean	containsHeap(NutsHeap heap) Indicates if the given heap equals to this heap or any heap of its composition.
List<Nut>	create(Nut nut, String path, NutDao.PathFormat pathFormat, ProcessContext processContext) Delegates method of NutDao.create(String, com.github.wuic.nut.dao.NutDao.PathFormat, com.github.wuic.ProcessContext) The DAO is picked from heap or its composition.
boolean	equals(Object o)
NutDao	findDaoFor(Nut nut) Finds the NutDao that created this nut.
NutsHeap	findHeapFor(Nut nut) Finds the NutsHeap that created this nut.
NutsHeap[]	getComposition() Returns the heaps that compose this instance.
Object	getFactory() An arbitrary object which helps to know how the listener has been created.
String	getId() Gets the heap's ID.
NutDao	getNutDao() Gets the NutDao of this NutsHeap.
List<Nut>	getNuts() Gets all the nuts of this heap.
Set<NutType>	getNutTypes() Gets the NutType types.
Boolean	hasCreated(Nut nut) Indicates if this NutsHeap has created thanks to its own DAO a Nut.
int	hashCode()
boolean	isDisposable() Indicates if this listener should be removed from the observable object when a call to NutDaoListener.polling(String, java.util.Set) or NutDaoListener.nutPolled(NutDao, String, Long) returns false.
boolean	notifyListeners(NutsHeap observable) Notifies the listeners that this heap has detected an update in one or many nuts.
boolean	nutPolled(NutDao dao, String path, Long timestamp) Called when a nut has been polled.
void	nutUpdated(NutsHeap heap) Called when a nut has been updated in the heap.
boolean	polling(String pattern, Set<String> paths) When a DAO performs a polling operation, this method is called first with all path which are going to be polled.
String	proxyUriFor(Nut nut) Delegates method of NutDao.proxyUriFor(Nut).
void	setNutDao(NutDao dao, Nut nut) Sets the NutDao for the heap that created the specified NutDao.
NutDao	withRootPath(String rootPath, Nut nut) Delegates method of NutDao.withRootPath(String).

Methods inherited from class java.lang.Object

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

Constructor Detail

NutsHeap

public NutsHeap(NutsHeap other)

Builds a heap by copy.

Parameters:

other - the heap to copy

NutsHeap

public NutsHeap(Object factoryObject,
        List<String> pathsList,
        boolean isDisposable,
        NutDao theNutDao,
        String heapId,
        NutsHeap... heaps)
         throws IOException

Builds a new NutsHeap. All the paths must be named with an extension that matches the NutType. If it is not the case, then an IllegalArgumentException will be thrown.

Some additional heaps could be specified to make a composition.

Parameters:

factoryObject - the factory object (see factory)

isDisposable - is disposable or not (see disposable

pathsList - the paths

theNutDao - the NutDao

heapId - the heap ID

heaps - some other heaps that compose this heap

Throws:

IOException - if the HEAP could not be created

NutsHeap

public NutsHeap(Object factoryObject,
        List<String> pathsList,
        NutDao theNutDao,
        String heapId,
        NutsHeap... heaps)
         throws IOException

Builds a heap which is not disposable.

Parameters:

factoryObject - the factory object (factory)

pathsList - the paths

theNutDao - the NutDao

heapId - the heap ID

heaps - some other heaps that compose this heap

Throws:

IOException - if the HEAP could not be created

Method Detail

findDaoFor

public NutDao findDaoFor(Nut nut)

Finds the NutDao that created this nut.

Parameters:

nut - the nut

Returns:

the nut's DAO, null if not found

findHeapFor

public NutsHeap findHeapFor(Nut nut)

Finds the NutsHeap that created this nut.

Parameters:

nut - the nut

Returns:

the nut's HEAP, null if not found

getNutDao

public NutDao getNutDao()

Gets the NutDao of this NutsHeap. Caution, don't use its method like NutDao.create(String, com.github.wuic.nut.dao.NutDao.PathFormat, com.github.wuic.ProcessContext), NutDao.proxyUriFor(Nut) or NutDao.withRootPath(String) but to the corresponding proxy methods in this class which check if the NutDao to actually use is not in one of the heaps that compose this NutsHeap.

Returns:

the NutDao

proxyUriFor

public String proxyUriFor(Nut nut)

Delegates method of NutDao.proxyUriFor(Nut). The DAO is picked from heap or its composition.

Parameters:

nut - the nut

Returns:

the proxy URI

withRootPath

public NutDao withRootPath(String rootPath,
                  Nut nut)

Delegates method of NutDao.withRootPath(String). The DAO is picked from heap or its composition.

Parameters:

nut - the root nut

rootPath - the path

Returns:

the proxy DAO

create

public List<Nut> create(Nut nut,
               String path,
               NutDao.PathFormat pathFormat,
               ProcessContext processContext)
                 throws IOException

Delegates method of NutDao.create(String, com.github.wuic.nut.dao.NutDao.PathFormat, com.github.wuic.ProcessContext) The DAO is picked from heap or its composition.

Parameters:

nut - the root nut

path - the nut path to create

pathFormat - the format

processContext - the process context

Returns:

the new nut

Throws:

IOException - if any I/O error occurs

addObserver

public void addObserver(HeapListener listener)

Observes all the nuts in this heap with the given listener.

Parameters:

listener - the listener

addCreate

public final void addCreate(String pattern,
             String path)

Refers a path as a resource created by this heap for the given pattern.

Parameters:

pattern - the pattern the is generated for

path - the created path resource

checkFiles

public void checkFiles(ProcessContext processContext)
                throws IOException

Checks that the NutType and the paths list of this heap are not null. If they are, this methods will throw an IllegalArgumentException. This exception could also be thrown if one path of the list does have a name which ends with one of the possible extensions.

Parameters:

processContext - the process context

Throws:

IOException - in I/O error case

getId

public String getId()

Gets the heap's ID.

Returns:

the ID

getNutTypes

public Set<NutType> getNutTypes()

Gets the NutType types.

Returns:

the types

setNutDao

public void setNutDao(NutDao dao,
             Nut nut)

Sets the NutDao for the heap that created the specified NutDao.

Parameters:

dao - the DAO

nut - the created nut

getNuts

public List<Nut> getNuts()

Gets all the nuts of this heap.

Returns:

the nuts

polling

public boolean polling(String pattern,
              Set<String> paths)

When a DAO performs a polling operation, this method is called first with all path which are going to be polled.

The paths are computed thanks to their representation (regex or not) specified when this listener has been registered to the observable.

If the listener returns false, the observable will stop notifying it only during the polling operation.

Specified by:

polling in interface NutDaoListener

Parameters:

pattern - the pattern (actually the path itself or a regex) corresponding to the paths

paths - all the real paths which are going to be polled

Returns:

false if polling should not be done, true otherwise

hasCreated

public Boolean hasCreated(Nut nut)

Indicates if this NutsHeap has created thanks to its own DAO a Nut. The methods search for the original nut if the specified nut is a generated one.

Parameters:

nut - the nut

Returns:

true if heap has created a Nut with this path, false otherwise

containsHeap

public boolean containsHeap(NutsHeap heap)

Indicates if the given heap equals to this heap or any heap of its composition. The equality if evaluated recursively through the composition.

Parameters:

heap - the heap to compare

Returns:

true if its equals to this heap or to a heap of its composition

nutPolled

public boolean nutPolled(NutDao dao,
                String path,
                Long timestamp)

Called when a nut has been polled.

When the observable object checks in one operation the changes on a set of nuts, the listener could notifies the observable to stop notifying it only during the operation.

Specified by:

nutPolled in interface NutDaoListener

Parameters:

dao - the DAO which polls

path - the polled path

timestamp - the timestamp retrieved when poling the nut

Returns:

true if this listener needs to be notified of any other update during the observable's operation, false otherwise

getComposition

public final NutsHeap[] getComposition()

Returns the heaps that compose this instance.

Returns:

this composition

notifyListeners

public boolean notifyListeners(NutsHeap observable)

Notifies the listeners that this heap has detected an update in one or many nuts.

Parameters:

observable - the heap where change has been detected

Returns:

false for convenient usage in caller

nutUpdated

public void nutUpdated(NutsHeap heap)

Called when a nut has been updated in the heap.

Specified by:

nutUpdated in interface HeapListener

isDisposable

public boolean isDisposable()

Indicates if this listener should be removed from the observable object when a call to NutDaoListener.polling(String, java.util.Set) or NutDaoListener.nutPolled(NutDao, String, Long) returns false.

If a listener is going to be removed, all the other listeners created by the same factory must be removed if and only if they are also disposable.

Specified by:

isDisposable in interface NutDaoListener

Returns:

true if this listener is disposable a described, false otherwise

getFactory

public Object getFactory()

An arbitrary object which helps to know how the listener has been created.

Specified by:

getFactory in interface NutDaoListener

Returns:

the factory object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object