org.esupportail.portal.utils.channels
Class SubChannel

java.lang.Object
  org.esupportail.portal.utils.channels.SubChannel

All Implemented Interfaces:

org.jasig.portal.ICacheable, ISubChannel

Direct Known Subclasses:

FatalError, Message, Todo

public abstract class SubChannel

extends java.lang.Object

implements ISubChannel

SubChannel

Classe abstraite qui propose une implémentation "type" de l'interface ISubChannel

(c)Copyright ESup-Portail 2004

Version:

1.0

Author:

Olivier Ziller

Constructor Summary

SubChannel(MainChannel mainChannel)
Constructeur d'une SubChannel Positionne une référence vers la channel principale

Method Summary

void	addDefaultXslParameters() Ajoute des paramètres XSL par défaut aux paramètres existant baseActionURL = url vers la channel en cours prefForm = prefixe à utiliser dans la feuille xslt pour s'assurer de l'unicité du nom des objects javascript mediaPath = chemins d'accès aux médias (images)
void	clearChannel() Méthode appellée lorsque la channel est réutilisée.
org.jasig.portal.ChannelCacheKey	generateKey()
MainChannel	getMainChannel() Récupére l'instance de la channel principale
java.lang.String	getMediaPath() Retourne le chemin d'accès aux médis
static java.lang.String	getPackageName(java.lang.Class c) Retourne le nom du package en cours
org.jasig.portal.ChannelRuntimeData	getRuntimeData() Récupère les runtimeData de la sous-channel
java.lang.String	getSSL() Récupère le fichier SSL à utiliser lors la transformation XSLT
java.lang.String	getXML() Récupère le XML à utiliser lors de l'affichage
java.lang.String	getXSL() Récupère le fichier XSL à utiliser lors de l'affichage
java.util.Hashtable	getXSLParameter() Récupère les paramètres à passer à la feuille XSL
java.lang.Boolean	init(org.jasig.portal.ChannelRuntimeData rd) Dans le cycle de vie d'une SubChannel, intervient en tout premier, juste après l'instanciation
boolean	isCacheValid(java.lang.Object validity)
void	log(org.apache.log4j.Priority level, java.lang.String logMessage) Log d'un message selon un niveau de priorité
void	log(java.lang.String logMessage) Log d'un message dans le fichier uportal.log
void	renderXML(org.xml.sax.ContentHandler out) Fait le rendu xml.
void	setDefaultXslParameters() Efface les paramètres XSL en cours et ajoute ceux par défaut
void	setOutput() Avant-derniere méthode appelée lors du cycle de vie d'une sous-channel Permet de positionner le nom du fichier xsl ou ssl
void	setSSL(java.lang.String ssl) Positionne la feuille ssl (null si pas de feuille ssl)
java.lang.Boolean	setXML() Dans le cycle de vie d'une sous-channel, méthode qui est appelée après l'initiation
void	setXML(java.lang.String string) Positionne la valeur du xml
void	setXSL(java.lang.String xsl) Positionne la valeur du fichier xsl
void	setXSLParameter(java.util.Hashtable hashtable) Positionne les paramètres de la feuille Xsl

Methods inherited from class java.lang.Object

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

Constructor Detail

SubChannel

public SubChannel(MainChannel mainChannel)

Constructeur d'une SubChannel Positionne une référence vers la channel principale

Parameters:

mainChannel - instance de la channel principale

Method Detail

init

public java.lang.Boolean init(org.jasig.portal.ChannelRuntimeData rd)
                       throws org.jasig.portal.PortalException,
                              FrameWorkException

Description copied from interface: ISubChannel

Dans le cycle de vie d'une SubChannel, intervient en tout premier, juste après l'instanciation

Specified by:

init in interface ISubChannel

Parameters:

rd - Les RuntimeData de la channel principale (MainChannel)

Returns:

Indique si le cycle de vie peut se poursuivre (passer à setXML)

Throws:

org.jasig.portal.PortalException

FrameWorkException

clearChannel

public void clearChannel()

Description copied from interface: ISubChannel

Méthode appellée lorsque la channel est réutilisée. Permet d'initialiser certaines données entre 2 utilisations (les paramètres XSL par exemple)

Specified by:

clearChannel in interface ISubChannel

setOutput

public void setOutput()
               throws FrameWorkException

Description copied from interface: ISubChannel

Avant-derniere méthode appelée lors du cycle de vie d'une sous-channel Permet de positionner le nom du fichier xsl ou ssl

Specified by:

setOutput in interface ISubChannel

Throws:

FrameWorkException

renderXML

public void renderXML(org.xml.sax.ContentHandler out)
               throws org.jasig.portal.PortalException

Description copied from interface: ISubChannel

Fait le rendu xml. Le moins de traitement doit être fait ici.

Specified by:

renderXML in interface ISubChannel

Parameters:

out -

Throws:

org.jasig.portal.PortalException

getXML

public java.lang.String getXML()

Description copied from interface: ISubChannel

Récupère le XML à utiliser lors de l'affichage

Specified by:

getXML in interface ISubChannel

Returns:

setXML

public void setXML(java.lang.String string)
            throws FrameWorkException

Description copied from interface: ISubChannel

Positionne la valeur du xml

Specified by:

setXML in interface ISubChannel

Parameters:

string -

Throws:

FrameWorkException

setXML

public java.lang.Boolean setXML()
                         throws FrameWorkException

Description copied from interface: ISubChannel

Dans le cycle de vie d'une sous-channel, méthode qui est appelée après l'initiation

Specified by:

setXML in interface ISubChannel

Returns:

Une réussite (ou non) qui indique si le cycle de vie se poursuit (passer à setOutput)

Throws:

FrameWorkException

getXSLParameter

public java.util.Hashtable getXSLParameter()

Description copied from interface: ISubChannel

Récupère les paramètres à passer à la feuille XSL

Specified by:

getXSLParameter in interface ISubChannel

Returns:

setXSLParameter

public void setXSLParameter(java.util.Hashtable hashtable)

Description copied from interface: ISubChannel

Positionne les paramètres de la feuille Xsl

Specified by:

setXSLParameter in interface ISubChannel

Parameters:

hashtable -

getMainChannel

public MainChannel getMainChannel()

Récupére l'instance de la channel principale

Returns:

Une référence vers l'instance de la channel principale

addDefaultXslParameters

public void addDefaultXslParameters()

Ajoute des paramètres XSL par défaut aux paramètres existant baseActionURL = url vers la channel en cours prefForm = prefixe à utiliser dans la feuille xslt pour s'assurer de l'unicité du nom des objects javascript mediaPath = chemins d'accès aux médias (images)

setDefaultXslParameters

public void setDefaultXslParameters()

Efface les paramètres XSL en cours et ajoute ceux par défaut

getRuntimeData

public org.jasig.portal.ChannelRuntimeData getRuntimeData()

Récupère les runtimeData de la sous-channel

Returns:

les runtimeData de la sous-channel

getSSL

public java.lang.String getSSL()

Description copied from interface: ISubChannel

Récupère le fichier SSL à utiliser lors la transformation XSLT

Specified by:

getSSL in interface ISubChannel

Returns:

getXSL

public java.lang.String getXSL()

Description copied from interface: ISubChannel

Récupère le fichier XSL à utiliser lors de l'affichage

Specified by:

getXSL in interface ISubChannel

Returns:

setSSL

public void setSSL(java.lang.String ssl)

Description copied from interface: ISubChannel

Positionne la feuille ssl (null si pas de feuille ssl)

Specified by:

setSSL in interface ISubChannel

Parameters:

ssl -

setXSL

public void setXSL(java.lang.String xsl)

Description copied from interface: ISubChannel

Positionne la valeur du fichier xsl

Specified by:

setXSL in interface ISubChannel

Parameters:

xsl -

getMediaPath

public java.lang.String getMediaPath()

Retourne le chemin d'accès aux médis

Returns:

le chemin d'accès aux médias

getPackageName

public static java.lang.String getPackageName(java.lang.Class c)

Retourne le nom du package en cours

Returns:

nom du package

generateKey

public org.jasig.portal.ChannelCacheKey generateKey()

Specified by:

generateKey in interface org.jasig.portal.ICacheable

isCacheValid

public boolean isCacheValid(java.lang.Object validity)

Specified by:

isCacheValid in interface org.jasig.portal.ICacheable

log

public void log(java.lang.String logMessage)

Description copied from interface: ISubChannel

Log d'un message dans le fichier uportal.log

Specified by:

log in interface ISubChannel

Parameters:

logMessage -

log

public void log(org.apache.log4j.Priority level,
                java.lang.String logMessage)

Description copied from interface: ISubChannel

Log d'un message selon un niveau de priorité

Specified by:

log in interface ISubChannel

Parameters:

level -

logMessage -