palio.modules
Class CMS

java.lang.Object
  palio.modules.core.Module
      palio.modules.CMS

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public class CMS
extends Module

Moduł implementujący podstawową funkcjonalność CMS w jPalio.

Moduł trzeba dodać w konfiguracji instancji jPalio.

Version:

0.6.1

Author:

Krzysztof Madyniak (kmadyniak@torn.com.pl)

Field Summary

static java.lang.String	DEFAULT_CONNECTOR_NAME
static java.lang.String	STATUS_ACTIVE
static java.lang.String	STATUS_NOT_ACTIVE
static java.lang.String	STATUS_REMOVED

Fields inherited from interface palio.modules.core.CurrentModuleDataKeys

DESIGNER_ACTIONS_BUFFER, HTML_FORM_BUILDER, HTML_MAP_BUILDER, HTML_MENU_BUILDER, HTML_TOOLTIPS_BUFFER, ITEXT_DOCUMENT, MAIL_MESSAGE, XLS_DOCUMENT, XML_DOCUMENT

Constructor Summary

CMS(Instance instance, java.util.Properties parameters)

Method Summary

void	clearCache() Czyści zawartość wszystkich keszy używanych przez moduł CMS
void	clearCategoryCache() Czyści zawartość kesza kategorii.
static java.lang.String	clearContent(java.lang.String content) Czyści treść depeszy z tagów <P>
static java.lang.String	createEmailLinks(java.lang.String text)
static java.lang.String	createUrlLinks(java.lang.String text)
static java.lang.String	createUrlLinks(java.lang.String text, java.lang.Long maxLinkLength)
java.lang.String	exportNews(java.lang.Long newsID)
java.lang.String	exportNews(java.lang.Long newsID, java.lang.Boolean includeCategories)
java.lang.String	exportNews(java.lang.Long newsID, java.lang.Long langID, java.lang.String outputEncoding, java.lang.Boolean includeCategories)
java.lang.String	exportNews(java.lang.Long newsID, java.lang.String outputEncoding, java.lang.Boolean includeCategories)
void	exportNews(java.lang.String connector, java.lang.Long newsID, java.lang.Long langID, java.lang.Boolean includeCategories, java.lang.Boolean includeMedia, java.lang.String xslt, java.lang.String serverDir, java.lang.Boolean compress)
java.lang.String	exportNews(java.lang.String connector, java.lang.Long newsID, java.lang.Long langID, java.lang.String outputEncoding, java.lang.Boolean includeCategories)
java.lang.String	exportNews(java.lang.String connector, java.lang.Long newsID, java.lang.Long langID, java.lang.String outputEncoding, java.lang.Boolean includeCategories, java.lang.String xslt)
java.lang.String	exportNewsML(java.lang.String connector, java.lang.Long newsID, java.lang.Long langID, java.util.Map parameters)
java.lang.String	exportNewsML(java.lang.String connector, java.lang.Long newsID, java.lang.Long langID, java.util.Map parameters, java.lang.String xslt)
void	exportNewsML(java.lang.String connector, java.lang.Long newsID, java.lang.Long langID, java.util.Map parameters, java.lang.String xslt, java.lang.String serverDir, java.lang.Boolean compress)
java.lang.Long	getCategoryIdByCode(java.lang.String code) Zwraca identyfikator kategorii na podstawie kodu
java.lang.Long	getCategoryIdByCode(java.lang.String connectorName, java.lang.String code) Zwraca identyfikator kategorii o podanym kodzie.
java.lang.Long	getCategoryIdByName(java.lang.String name, java.lang.Long parentId) Zwraca identyfikator kategorii o podanej nazwie oraz kategorii nadrzędnej o podanym identyfikatorze
java.lang.Object[]	getCategoryIdsByCodes(java.lang.Object[] codes) Zwraca tablicę identyfikatorów kategorii na podstawie podanych kodów
java.lang.String	getCategoryName(java.lang.Long id) Zwraca nazwę kategorii
java.lang.String	getCategoryName(java.lang.String code) Zwraca nazwę kategorii
java.lang.String	getCategoryName(java.lang.String connectorName, java.lang.Long id) Zwraca nazwę kategorii
java.lang.String	getCategoryName(java.lang.String connectorName, java.lang.String code) Zwraca nazwę kategorii
java.lang.String	getConnectorName()
java.lang.Object[]	getImage(java.lang.Long mediaId, java.lang.String thumbnailTypeCode) Zwraca strukturę reprezentującą dowolny obrazek w formacie: [url, width, height]
java.lang.Long	getLanguageIdByCode(java.lang.String languageCode)
java.lang.Long	getLanguageIdByCode(java.lang.String connectorName, java.lang.String languageCode)
java.util.LinkedList	getLatestNews(java.lang.String newsType, java.lang.Object[] categories, java.lang.Boolean includeSubcategories, java.lang.String language, java.lang.Long urgency, java.lang.Boolean firstPageInPortal, java.lang.Long limit) Zwraca najnowsze newsy wg podanych kryteriów.
java.util.LinkedList	getLatestNews(java.lang.String newsType, java.lang.String language, java.lang.Long urgency, java.lang.Boolean firstPageInPortal, java.lang.Long limit) Zwraca najnowsze newsy wg podanych kryteriów.
java.util.LinkedList	getLatestNews(java.lang.String newsType, java.lang.String category, java.lang.String language, java.lang.Long urgency, java.lang.Boolean firstPageInPortal, java.lang.Boolean firstPageInCategory, java.lang.Boolean mainInCategory, java.lang.Long limit) Zwraca najnowsze newsy wg podanych kryteriów.
java.lang.Object[]	getMainImage(java.lang.Long newsId, java.lang.String thumbnailTypeCode) Zwraca strukturę reprezentującą główny obrazek newsa w formacie: [url, width, height] Jeżeli nie ma przypisanego głównego obrazka do newsa zwracany jest null
java.lang.String	getMediaUrl(java.lang.Long mediaId) Zwraca url do dowolnego obiektu multimedialnego
java.lang.Object[]	getNews(java.lang.Long newsId, java.lang.String language) Zwraca dane dot. newsa o podanym identyfikatorze w podanym języku.
java.lang.Object	getNewsItem(java.lang.Long newsId, java.lang.Long languageId, java.lang.String itemName)
java.lang.Object	getNewsItem(java.lang.String connectorName, java.lang.Long newsId, java.lang.Long languageId, java.lang.String itemName)
java.lang.Long	getNewsTypeIdByCode(java.lang.String newsTypeCode)
java.lang.Long	getNewsTypeIdByCode(java.lang.String connectorName, java.lang.String newsTypeCode)
java.lang.String	getSubCategoryIdsAsText(java.lang.Long categoryId) Zwraca identyfikatory kategorii podrzednych w stosunku do podanej kategorii (razem z podana kategoria).
java.lang.String	getSubCategoryIdsAsText(java.lang.Object[] categoryIds) Zwraca identyfikatory kategorii podrzednych w stosunku do podanych kategorii (razem z podanymi kategoriami).
java.lang.String	getSubCategoryIdsAsText(java.lang.String connectorName, java.lang.Long categoryId) Zwraca identyfikatory kategorii podrzednych w stosunku do podanej kategorii (razem z podana kategoria).
java.lang.String	getSubCategoryIdsAsText(java.lang.String connectorName, java.lang.Object[] categoryIds) Zwraca identyfikatory kategorii podrzednych w stosunku do podanych kategorii (razem z podanymi kategoriami).
java.lang.String	getVersion() Returns the module version
static java.lang.String	mediaURL(java.lang.Object ID, java.lang.Boolean longVersion) Deprecated. Replaced by getMediaUrl(Long).
static java.lang.String	mediaURL(java.lang.String connector, java.lang.Object ID, java.lang.Boolean longVersion) Deprecated. Replaced by ....

Methods inherited from class palio.modules.core.Module

getConfigParam, getDescription, getModuleTranslation

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_ACTIVE

public static java.lang.String STATUS_ACTIVE

STATUS_NOT_ACTIVE

public static java.lang.String STATUS_NOT_ACTIVE

STATUS_REMOVED

public static java.lang.String STATUS_REMOVED

DEFAULT_CONNECTOR_NAME

public static final java.lang.String DEFAULT_CONNECTOR_NAME

See Also:

Constant Field Values

Constructor Detail

CMS

public CMS(Instance instance,
           java.util.Properties parameters)

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from class: Module

Returns the module version

Specified by:

getVersion in class Module

getConnectorName

public java.lang.String getConnectorName()

clearCache

public void clearCache()

Czyści zawartość wszystkich keszy używanych przez moduł CMS

Since:

jPALIO 6.10.2, module 0.6.0

getCategoryIdByCode

public java.lang.Long getCategoryIdByCode(java.lang.String code)
                                   throws palio.PalioException

Zwraca identyfikator kategorii na podstawie kodu

Parameters:

code - kod kategorii

Throws:

palio.PalioException

getCategoryIdsByCodes

public java.lang.Object[] getCategoryIdsByCodes(java.lang.Object[] codes)
                                         throws palio.PalioException

Zwraca tablicę identyfikatorów kategorii na podstawie podanych kodów

Parameters:

codes -

Returns:

identyfikatory kategorii

Throws:

palio.PalioException

getCategoryIdByCode

public java.lang.Long getCategoryIdByCode(java.lang.String connectorName,
                                          java.lang.String code)
                                   throws palio.PalioException

Zwraca identyfikator kategorii o podanym kodzie. W przypadku gdy nie zostanie podany argument connectorName zwracana jest wartość z kesza, zbudowanego przy użyciu domyślego konektora. W przypadu gdy zostanie podana nazwa konektora (roznego od domyślego) dane pobierane sa bezposrednio z bazy danych (brak keszowania)

Parameters:

connectorName - nazwa konektora

code - kod kategorii

Returns:

identyfikator kategorii

Throws:

palio.PalioException

getCategoryIdByName

public java.lang.Long getCategoryIdByName(java.lang.String name,
                                          java.lang.Long parentId)
                                   throws palio.PalioException

Zwraca identyfikator kategorii o podanej nazwie oraz kategorii nadrzędnej o podanym identyfikatorze

Parameters:

name - nazwa kategorii

parentId - identyfikator kategorii nadrzędnej

Throws:

palio.PalioException

getCategoryName

public java.lang.String getCategoryName(java.lang.String connectorName,
                                        java.lang.Long id)
                                 throws palio.PalioException

Zwraca nazwę kategorii

Parameters:

connectorName - nazwa konektora

id - identyfikator kategorii

Throws:

palio.PalioException

getCategoryName

public java.lang.String getCategoryName(java.lang.Long id)
                                 throws palio.PalioException

Zwraca nazwę kategorii

Parameters:

id - identyfikator kategorii

Throws:

palio.PalioException

getCategoryName

public java.lang.String getCategoryName(java.lang.String connectorName,
                                        java.lang.String code)
                                 throws palio.PalioException

Zwraca nazwę kategorii

Parameters:

connectorName - nazwa konektora

code - kod kategorii

Throws:

palio.PalioException

getCategoryName

public java.lang.String getCategoryName(java.lang.String code)
                                 throws palio.PalioException

Zwraca nazwę kategorii

Parameters:

code - kod kategorii

Throws:

palio.PalioException

getSubCategoryIdsAsText

public final java.lang.String getSubCategoryIdsAsText(java.lang.Long categoryId)
                                               throws palio.PalioException

Zwraca identyfikatory kategorii podrzednych w stosunku do podanej kategorii (razem z podana kategoria). Identyfikatory sa zwracane jako tekst w postaci wartości identyfikatorów rozdzielonych przecinkami. Metoda używa domyślnego konetora o nazwie "cms".

Parameters:

categoryId - identyfikator nadrzednej kategorii

Throws:

palio.PalioException

getSubCategoryIdsAsText

public final java.lang.String getSubCategoryIdsAsText(java.lang.String connectorName,
                                                      java.lang.Long categoryId)
                                               throws palio.PalioException

Zwraca identyfikatory kategorii podrzednych w stosunku do podanej kategorii (razem z podana kategoria). Identyfikatory sa zwracane jako tekst w postaci wartości identyfikatorów rozdzielonych przecinkami.

Parameters:

connectorName - nazwa konektora bazy danych CMS

categoryId - identyfikator nadrzednej kategorii

Throws:

palio.PalioException

getSubCategoryIdsAsText

public final java.lang.String getSubCategoryIdsAsText(java.lang.Object[] categoryIds)
                                               throws palio.PalioException

Zwraca identyfikatory kategorii podrzednych w stosunku do podanych kategorii (razem z podanymi kategoriami). Identyfikatory sa zwracane jako tekst w postaci wartości identyfikatorów rozdzielonych przecinkami. Metoda używa domyślnego konetora o nazwie "cms".

Parameters:

categoryIds - tablica z identyfikatorami nadrzednych kategorii

Throws:

palio.PalioException

getSubCategoryIdsAsText

public final java.lang.String getSubCategoryIdsAsText(java.lang.String connectorName,
                                                      java.lang.Object[] categoryIds)
                                               throws palio.PalioException

Zwraca identyfikatory kategorii podrzednych w stosunku do podanych kategorii (razem z podanymi kategoriami). Identyfikatory sa zwracane jako tekst w postaci wartości identyfikatorów rozdzielonych przecinkami.

Parameters:

connectorName - nazwa konektora bazy danych CMS

categoryIds - tablica z identyfikatorami nadrzednych kategorii

Throws:

palio.PalioException

clearCategoryCache

public void clearCategoryCache()

Czyści zawartość kesza kategorii.

getNewsItem

public java.lang.Object getNewsItem(java.lang.String connectorName,
                                    java.lang.Long newsId,
                                    java.lang.Long languageId,
                                    java.lang.String itemName)
                             throws palio.PalioException

Throws:

palio.PalioException

getNewsItem

public java.lang.Object getNewsItem(java.lang.Long newsId,
                                    java.lang.Long languageId,
                                    java.lang.String itemName)
                             throws palio.PalioException

Throws:

palio.PalioException

getNewsTypeIdByCode

public java.lang.Long getNewsTypeIdByCode(java.lang.String connectorName,
                                          java.lang.String newsTypeCode)
                                   throws palio.PalioException

Throws:

palio.PalioException

getNewsTypeIdByCode

public java.lang.Long getNewsTypeIdByCode(java.lang.String newsTypeCode)
                                   throws palio.PalioException

Throws:

palio.PalioException

getLanguageIdByCode

public java.lang.Long getLanguageIdByCode(java.lang.String connectorName,
                                          java.lang.String languageCode)
                                   throws palio.PalioException

Throws:

palio.PalioException

getLanguageIdByCode

public java.lang.Long getLanguageIdByCode(java.lang.String languageCode)
                                   throws palio.PalioException

Throws:

palio.PalioException

mediaURL

@Deprecated
public static java.lang.String mediaURL(java.lang.Object ID,
                                                   java.lang.Boolean longVersion)

Deprecated. Replaced by getMediaUrl(Long).

See Also:

getMediaUrl(Long)

mediaURL

@Deprecated
public static java.lang.String mediaURL(java.lang.String connector,
                                                   java.lang.Object ID,
                                                   java.lang.Boolean longVersion)

Deprecated. Replaced by ....

clearContent

public static java.lang.String clearContent(java.lang.String content)

Czyści treść depeszy z tagów <P>

Parameters:

content - treść do obróbki

createUrlLinks

public static java.lang.String createUrlLinks(java.lang.String text)

createUrlLinks

public static java.lang.String createUrlLinks(java.lang.String text,
                                              java.lang.Long maxLinkLength)

createEmailLinks

public static java.lang.String createEmailLinks(java.lang.String text)

getNews

public java.lang.Object[] getNews(java.lang.Long newsId,
                                  java.lang.String language)
                           throws palio.PalioException

Zwraca dane dot. newsa o podanym identyfikatorze w podanym języku. News reprezentowany jest przez następującą tablicę:
[id, publication_date, title, lead, content]

Parameters:

newsId - identyfikator newsa

language - kod języka

Returns:

news Object[]

Throws:

palio.PalioException

getLatestNews

public java.util.LinkedList getLatestNews(java.lang.String newsType,
                                          java.lang.String language,
                                          java.lang.Long urgency,
                                          java.lang.Boolean firstPageInPortal,
                                          java.lang.Long limit)
                                   throws palio.PalioException

Zwraca najnowsze newsy wg podanych kryteriów. Newsy reprezentowane są przez następującą tablicę:
[id, publication_date, title, lead]

Parameters:

newsType - kod typu newsa

language - język

urgency - poziom pilności

firstPageInPortal - czy news z pierwszej strony portalu

limit - ilość zwróconych newsów

Throws:

palio.PalioException

getLatestNews

public java.util.LinkedList getLatestNews(java.lang.String newsType,
                                          java.lang.String category,
                                          java.lang.String language,
                                          java.lang.Long urgency,
                                          java.lang.Boolean firstPageInPortal,
                                          java.lang.Boolean firstPageInCategory,
                                          java.lang.Boolean mainInCategory,
                                          java.lang.Long limit)
                                   throws palio.PalioException

Zwraca najnowsze newsy wg podanych kryteriów. Newsy reprezentowane są przez następującą tablicę:
[id, publication_date, title, lead]

Parameters:

newsType - kod typu newsa

category - kod kategorii

language - kod języka

urgency - poziom pilności

firstPageInPortal - czy news z pierwszej strony portalu

firstPageInCategory - czy news z pierwszej strony portalu w danej kategorii

mainInCategory - czy news główny w danej kategorii

limit - ilość zwróconych newsów

Throws:

palio.PalioException

getLatestNews

public java.util.LinkedList getLatestNews(java.lang.String newsType,
                                          java.lang.Object[] categories,
                                          java.lang.Boolean includeSubcategories,
                                          java.lang.String language,
                                          java.lang.Long urgency,
                                          java.lang.Boolean firstPageInPortal,
                                          java.lang.Long limit)
                                   throws palio.PalioException

Zwraca najnowsze newsy wg podanych kryteriów. Newsy reprezentowane są przez następującą tablicę:
[id, publication_date, title, lead]

Parameters:

newsType - kod typu newsa

categories - kody kategorii

includeSubcategories - czy uwzględnić podkategorie

language - kod języka

urgency - poziom pilności

firstPageInPortal - czy news z pierwszej strony portalu

limit - ilość zwróconych newsów

Throws:

palio.PalioException

getMainImage

public java.lang.Object[] getMainImage(java.lang.Long newsId,
                                       java.lang.String thumbnailTypeCode)
                                throws palio.PalioException

Zwraca strukturę reprezentującą główny obrazek newsa w formacie:
[url, width, height]
Jeżeli nie ma przypisanego głównego obrazka do newsa zwracany jest null

Parameters:

newsId - identyfikator newsa

thumbnailTypeCode - kod typu miniatury (jeżeli null zwracana jest struktura reprezentująca obrazek w oryginalnych wymiarach)

Throws:

palio.PalioException

getImage

public java.lang.Object[] getImage(java.lang.Long mediaId,
                                   java.lang.String thumbnailTypeCode)
                            throws palio.PalioException

Zwraca strukturę reprezentującą dowolny obrazek w formacie:
[url, width, height]

Parameters:

mediaId - identyfikator obrazka

thumbnailTypeCode - kod typu miniatury (jeżeli null zwracana jest struktura reprezentująca obrazek w oryginalnych wymiarach)

Returns:

Image Object[]

Throws:

palio.PalioException

getMediaUrl

public java.lang.String getMediaUrl(java.lang.Long mediaId)

Zwraca url do dowolnego obiektu multimedialnego

Parameters:

mediaId - identyfikator obiektu multimedialnego

exportNewsML

public final java.lang.String exportNewsML(java.lang.String connector,
                                           java.lang.Long newsID,
                                           java.lang.Long langID,
                                           java.util.Map parameters)
                                    throws palio.PalioException

Throws:

palio.PalioException

exportNewsML

public final java.lang.String exportNewsML(java.lang.String connector,
                                           java.lang.Long newsID,
                                           java.lang.Long langID,
                                           java.util.Map parameters,
                                           java.lang.String xslt)
                                    throws palio.PalioException

Throws:

palio.PalioException

exportNewsML

public final void exportNewsML(java.lang.String connector,
                               java.lang.Long newsID,
                               java.lang.Long langID,
                               java.util.Map parameters,
                               java.lang.String xslt,
                               java.lang.String serverDir,
                               java.lang.Boolean compress)
                        throws java.io.IOException,
                               palio.PalioException

Throws:

java.io.IOException

palio.PalioException

exportNews

public final void exportNews(java.lang.String connector,
                             java.lang.Long newsID,
                             java.lang.Long langID,
                             java.lang.Boolean includeCategories,
                             java.lang.Boolean includeMedia,
                             java.lang.String xslt,
                             java.lang.String serverDir,
                             java.lang.Boolean compress)
                      throws java.io.IOException,
                             palio.PalioException

Throws:

java.io.IOException

palio.PalioException

exportNews

public final java.lang.String exportNews(java.lang.String connector,
                                         java.lang.Long newsID,
                                         java.lang.Long langID,
                                         java.lang.String outputEncoding,
                                         java.lang.Boolean includeCategories,
                                         java.lang.String xslt)
                                  throws java.io.IOException,
                                         palio.PalioException

Throws:

java.io.IOException

palio.PalioException

exportNews

public final java.lang.String exportNews(java.lang.String connector,
                                         java.lang.Long newsID,
                                         java.lang.Long langID,
                                         java.lang.String outputEncoding,
                                         java.lang.Boolean includeCategories)
                                  throws java.io.IOException,
                                         palio.PalioException

Throws:

java.io.IOException

palio.PalioException

exportNews

public final java.lang.String exportNews(java.lang.Long newsID,
                                         java.lang.Long langID,
                                         java.lang.String outputEncoding,
                                         java.lang.Boolean includeCategories)
                                  throws java.io.IOException,
                                         palio.PalioException

Throws:

java.io.IOException

palio.PalioException

exportNews

public final java.lang.String exportNews(java.lang.Long newsID,
                                         java.lang.String outputEncoding,
                                         java.lang.Boolean includeCategories)
                                  throws java.io.IOException,
                                         palio.PalioException

Throws:

java.io.IOException

palio.PalioException

exportNews

public final java.lang.String exportNews(java.lang.Long newsID,
                                         java.lang.Boolean includeCategories)
                                  throws java.io.IOException,
                                         palio.PalioException

Throws:

java.io.IOException

palio.PalioException

exportNews

public final java.lang.String exportNews(java.lang.Long newsID)
                                  throws java.io.IOException,
                                         palio.PalioException

Throws:

java.io.IOException

palio.PalioException