Package org.ametys.plugins.ai.search

Class CacheDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.ai.search.CacheDAO

All Implemented Interfaces:

DeferredServiceable, LogEnabled, PluginAware, Disposable, Component, Contextualizable

public class CacheDAO
extends AbstractLogEnabled
implements DeferredServiceable, PluginAware, Contextualizable, Component, Disposable

DAO for AI cache management.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CACHEROOT_CONTENT_DATA_CONTENTID	The property name to store content id on Content node of the cache
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
CacheDAO()

Method Summary

Modifier and Type	Method	Description
protected <T extends AmetysObject> T	_getOrCreateNode(JCRTraversableAmetysObject parentNode, String nodeName, String nodeType)	Get or create a node
void	contextualize(Context context)
void	deferredService(ServiceManager manager)	Pass the ServiceManager used to access other components.
void	dispose()
DefaultTraversableAmetysObject	getCacheContentNode(Content content, boolean creates)	Get the cache node for a given content id
DefaultTraversableAmetysObject	getCacheContentVersionNode(Content content, String version)	Get the cache node for a given content id
AmetysObjectCollection	getCacheRootNode()	Get the root plugin storage object.
CacheContentVersionChunk	getChunk(DefaultTraversableAmetysObject cacheContentVersionNode, int number, boolean createIfNotExist)	Get or create a chunk node
DefaultTraversableAmetysObject	getNearestCacheContentVersionNode(Content content, String version)	Get the cache node for a given content id
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The avalon role

CACHEROOT_CONTENT_DATA_CONTENTID

public static final String CACHEROOT_CONTENT_DATA_CONTENTID

The property name to store content id on Content node of the cache

See Also:

• Constant Field Values

Constructor Details

CacheDAO

public CacheDAO()

Method Details

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

deferredService

public void deferredService(ServiceManager manager)
                     throws ServiceException

Description copied from interface: DeferredServiceable

Pass the ServiceManager used to access other components.

Specified by:

deferredService in interface DeferredServiceable

Parameters:

manager - The ServiceManager which this DeferredServiceable uses. Must not be null.

Throws:

ServiceException - if an error occurs

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

getCacheRootNode

public AmetysObjectCollection getCacheRootNode()
                                        throws AmetysRepositoryException,
javax.jcr.LoginException,
javax.jcr.RepositoryException

Get the root plugin storage object.

Returns:

the root plugin storage object.

Throws:

AmetysRepositoryException - if a repository error occurs.

javax.jcr.RepositoryException - if a repository error occurs.

javax.jcr.LoginException - if a repository error occurs.

getCacheContentNode

public DefaultTraversableAmetysObject getCacheContentNode(Content content,
 boolean creates)
                                                   throws AmetysRepositoryException,
javax.jcr.RepositoryException

Get the cache node for a given content id

Parameters:

content - the content

creates - Create the node if not existing

Returns:

the cache node or null if not existing and not created

Throws:

AmetysRepositoryException - if an error occurs when manipulating the repository

javax.jcr.RepositoryException - if an error occurs when manipulating the repository

getNearestCacheContentVersionNode

public DefaultTraversableAmetysObject getNearestCacheContentVersionNode(Content content,
 String version)
                                                                 throws AmetysRepositoryException,
javax.jcr.LoginException,
javax.jcr.RepositoryException

Get the cache node for a given content id

Parameters:

content - the content

version - the content version

Returns:

the cache node

Throws:

AmetysRepositoryException - if an error occurs when manipulating the repository

javax.jcr.RepositoryException - if an error occurs when manipulating the repository

javax.jcr.LoginException - if an error occurs when manipulating the repository

getCacheContentVersionNode

public DefaultTraversableAmetysObject getCacheContentVersionNode(Content content,
 String version)
                                                          throws AmetysRepositoryException,
javax.jcr.LoginException,
javax.jcr.RepositoryException

Get the cache node for a given content id

Parameters:

content - the content

version - the content version

Returns:

the cache node

Throws:

AmetysRepositoryException - if an error occurs when manipulating the repository

javax.jcr.RepositoryException - if an error occurs when manipulating the repository

javax.jcr.LoginException - if an error occurs when manipulating the repository

getChunk

public CacheContentVersionChunk getChunk(DefaultTraversableAmetysObject cacheContentVersionNode,
 int number,
 boolean createIfNotExist)
                                  throws AmetysRepositoryException

Get or create a chunk node

Parameters:

cacheContentVersionNode - The cache content version node

number - the chunk number

createIfNotExist - true to create the chunk if it does not exist

Returns:

The retrieved or created chunk node, or null otherwise

Throws:

AmetysRepositoryException - if an error occurs when manipulating the repository

_getOrCreateNode

protected <T extends AmetysObject> T _getOrCreateNode(JCRTraversableAmetysObject parentNode,
 String nodeName,
 String nodeType)
                                               throws AmetysRepositoryException

Get or create a node

Type Parameters:

T - The type of the node

Parameters:

parentNode - the parent node

nodeName - the name of the node

nodeType - the type of the node

Returns:

The retrieved or created node

Throws:

AmetysRepositoryException - if an error occurs when manipulating the repository