org.apache.cocoon.portal.aspect
Interface Aspectalizable

All Known Subinterfaces:

CompositeLayout, Layout, Producible

All Known Implementing Classes:

AbstractAspectalizable, AbstractLayout, AbstractProducible, CompositeLayoutImpl, CopletData, CopletInstanceData, CopletLayout, FrameLayout, LinkLayout

public interface Aspectalizable

This interface marks an object that can be used by aspects. An aspect can store any arbitrary information in an aspectalizable object.

Version:

CVS $Id: Aspectalizable.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler, Volker Schmitt

Method Summary

void	addPersistentAspectData(String aspectName, Object data)
Object	getAspectData(String aspectName) Get the data associated with an aspect
Map	getAspectDatas() Return all aspect datas
Map	getPersistentAspectData() Return all persistent aspect datas
boolean	isAspectSupported(String aspectName) Is this aspect supported
void	setAspectData(String aspectName, Object data) Set the data associated with an aspect The data is only set if the object is associated with the given aspect
void	setAspectDataHandler(AspectDataHandler handler) This method is invoked once to set the handler

Method Detail

getAspectData

Object getAspectData(String aspectName)

Get the data associated with an aspect

Parameters:

aspectName - The aspect name

Returns:

The data or null if the aspect is not associated with this object

setAspectData

void setAspectData(String aspectName,
                   Object data)

Set the data associated with an aspect The data is only set if the object is associated with the given aspect

Parameters:

aspectName - The aspect name

data - The data

getAspectDatas

Map getAspectDatas()

Return all aspect datas

Returns:

A map of data objects, the keys are built by the aspect names

getPersistentAspectData

Map getPersistentAspectData()

Return all persistent aspect datas

Returns:

A map of data objects, the keys are built by the aspect names

addPersistentAspectData

void addPersistentAspectData(String aspectName,
                             Object data)

isAspectSupported

boolean isAspectSupported(String aspectName)

Is this aspect supported

setAspectDataHandler

void setAspectDataHandler(AspectDataHandler handler)

This method is invoked once to set the handler