Package lumis.portal.channel.tree

Class ChannelTreeDaoJdbc

java.lang.Object

lumis.portal.channel.tree.ChannelTreeDaoJdbc

All Implemented Interfaces:

IChannelTreeDao

public class ChannelTreeDaoJdbc
extends java.lang.Object
implements IChannelTreeDao

Dao Jdbc for channel tree.

Since:

4.0.0

Version:

$Revision$ $Date$

Field Summary

Fields inherited from interface lumis.portal.channel.tree.IChannelTreeDao

HIDE_TYPE_ALWAYS, HIDE_TYPE_IF_HIDDEN_SPECIFIED, HIDE_TYPE_NEVER

Constructor Summary

Constructors

Constructor	Description
ChannelTreeDaoJdbc()

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.util.List<lumis.portal.channel.tree.Channel>>	getBasicData(java.lang.String channelId, boolean hideChannelTemplates, java.lang.String primaryServiceInstanceId, ITransaction transaction)	Get the basic tree data of the channel considering area tags from each channel.
java.util.Map<java.lang.String,java.util.List<lumis.portal.channel.tree.Channel>>	getBasicData(java.lang.String channelId, boolean hideChannelTemplates, ITransaction transaction)	Get the basic tree data of the channel.
java.util.Map<java.lang.String,java.util.List<lumis.portal.channel.tree.Channel>>	getBasicDataWithAreaTags(java.lang.String channelId, java.lang.String rootChannelId, boolean hideChannelTemplates, java.util.Collection<java.lang.String> areaTags, ITransaction transaction)	Get the basic tree data of the channel (with a given root channel) considering area tags from each child channels.
java.util.Map<java.lang.String,java.util.List<lumis.portal.channel.tree.Channel>>	getBasicDataWithRootChannel(java.lang.String channelId, java.lang.String rootChannelId, boolean hideChannelTemplates, ITransaction transaction)	Get the basic tree data of the channel (with a given root channel).
org.json.simple.JSONArray	getChannelChildren(java.lang.String channelId, ITransaction transaction)
org.json.simple.JSONObject	getChannelTree(java.lang.String channelId, boolean includeParents, boolean localizeNames, ITransaction transaction)
java.util.Map<java.lang.String,java.util.List<lumis.portal.channel.tree.Channel>>	getChildrenData(java.lang.String channelId, int hideChannels, int hidePages, int hidePageTemplates, int hideChannelTemplates, ITransaction transaction)	Get the tree childen's data of the channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelTreeDaoJdbc

public ChannelTreeDaoJdbc()

Method Detail

getChannelTree

public org.json.simple.JSONObject getChannelTree(java.lang.String channelId,
                                                 boolean includeParents,
                                                 boolean localizeNames,
                                                 ITransaction transaction)
                                          throws DaoException,
                                                 PortalException

Specified by:

getChannelTree in interface IChannelTreeDao

Throws:

DaoException

PortalException

getChannelChildren

public org.json.simple.JSONArray getChannelChildren(java.lang.String channelId,
                                                    ITransaction transaction)
                                             throws DaoException,
                                                    PortalException

Specified by:

getChannelChildren in interface IChannelTreeDao

Throws:

DaoException

PortalException

getBasicData

public java.util.Map<java.lang.String,java.util.List<lumis.portal.channel.tree.Channel>> getBasicData(java.lang.String channelId,
                                                                                                            boolean hideChannelTemplates,
                                                                                                            ITransaction transaction)
                                                                                                     throws DaoException,
                                                                                                            PortalException

Description copied from interface: IChannelTreeDao

Get the basic tree data of the channel. This method returns all the parents (entire ancestry) of the given channel. This is the minimum information required to render a channel within its tree.

Specified by:

getBasicData in interface IChannelTreeDao

Returns:

Throws:

DaoException

PortalException

getBasicDataWithRootChannel

public java.util.Map<java.lang.String,java.util.List<lumis.portal.channel.tree.Channel>> getBasicDataWithRootChannel(java.lang.String channelId,
                                                                                                                           java.lang.String rootChannelId,
                                                                                                                           boolean hideChannelTemplates,
                                                                                                                           ITransaction transaction)
                                                                                                                    throws PortalException

Description copied from interface: IChannelTreeDao

Get the basic tree data of the channel (with a given root channel). This method returns all the parents (entire ancestry) of the given channel. This is the minimum information required to render a channel within its tree.

Specified by:

getBasicDataWithRootChannel in interface IChannelTreeDao

Parameters:

channelId - the channel id.

rootChannelId - the root channel id.

hideChannelTemplates - hides the channel templates.

transaction - the transaction to be used.

Returns:

the basic tree data of the channel (with a given root channel)

Throws:

PortalException

getBasicDataWithAreaTags

public java.util.Map<java.lang.String,java.util.List<lumis.portal.channel.tree.Channel>> getBasicDataWithAreaTags(java.lang.String channelId,
                                                                                                                        java.lang.String rootChannelId,
                                                                                                                        boolean hideChannelTemplates,
                                                                                                                        java.util.Collection<java.lang.String> areaTags,
                                                                                                                        ITransaction transaction)
                                                                                                                 throws PortalException

Description copied from interface: IChannelTreeDao

Get the basic tree data of the channel (with a given root channel) considering area tags from each child channels. This method returns all the parents (entire ancestry) of the given channel. This is the minimum information required to render a channel within its tree.

Specified by:

getBasicDataWithAreaTags in interface IChannelTreeDao

Parameters:

channelId - the current channel id.

rootChannelId - the root channel that will be used as reference to start the query.

hideChannelTemplates - if is to hide or not channel templates.

areaTags - the list of area tags that the channels must have (at least one) to be returned.

transaction - the transaction to be used during the process.

Returns:

Get the basic tree data of the channel (with a given root channel) considering area tags from each child channels.

Throws:

PortalException - if any other error occurs during the process.

getChildrenData

public java.util.Map<java.lang.String,java.util.List<lumis.portal.channel.tree.Channel>> getChildrenData(java.lang.String channelId,
                                                                                                               int hideChannels,
                                                                                                               int hidePages,
                                                                                                               int hidePageTemplates,
                                                                                                               int hideChannelTemplates,
                                                                                                               ITransaction transaction)
                                                                                                        throws DaoException,
                                                                                                               PortalException

Description copied from interface: IChannelTreeDao

Get the tree childen's data of the channel.

Specified by:

getChildrenData in interface IChannelTreeDao

Returns:

Throws:

DaoException

PortalException

getBasicData

public java.util.Map<java.lang.String,java.util.List<lumis.portal.channel.tree.Channel>> getBasicData(java.lang.String channelId,
                                                                                                            boolean hideChannelTemplates,
                                                                                                            java.lang.String primaryServiceInstanceId,
                                                                                                            ITransaction transaction)
                                                                                                     throws DaoException,
                                                                                                            PortalException

Description copied from interface: IChannelTreeDao

Get the basic tree data of the channel considering area tags from each channel. This method returns all the parents (entire ancestry) of the given channel. This is the minimum information required to render a channel within its tree.

Specified by:

getBasicData in interface IChannelTreeDao

Parameters:

channelId - the current channel id.

hideChannelTemplates - if is to hide or not channel templates.

transaction - the transaction to be used during the process.

Returns:

the basic tree data of the channel considering area tags from each channel.

Throws:

DaoException - if any error occurs during the data base query.

PortalException - if any other error occurs during the process.