Programando contenidos en Liferay 6

Enviado por Jesús Salinas R... el Lun, 10/03/2011 - 12:43.

<h1>¿Qué es un contenido?</h1>
Un contenido será cualquier entidad que podemos etiquetar o categorizar. Liferay los identifica con el término asset y proporciona un framework para su gestión. Los tipos de contenido que Liferay maneja por defecto son:
<ul>
<li>Contenidos web (Web Content).</li>
<li>Imágenes de la galería de Imágenes (Image Gallery Image).</li>
<li>Entradas de blog (Blog Entry).</li>
<li>Documentos de la biblioteca de documentos (Document Library Document).</li>
<li>Marcador (Bookmark).</li>
<li>Mensaje en un foro (Message Board message).</li>
<li>Página en una Wiki (Wiki page).</li>
<li>Evento de calendario (Calendar Event).</li>
</ul>
<h1>La API para manejar Assets</h1>
Para trabajar con asset se debe manejar dos conceptos, su modelo y su servicio asociados.
La interface AssetEntry representa el concepto de asset y su tabla asociada en la base de datos de Liferay se llama assetentry. Sus campos más importantes son:
<ul>
<li>entryId: identificador único del asset.</li>
<li>userId: identificador del usuario que crea el contenido.</li>
<li>groupId: identifica el alcance en el que ha sido creado.</li>
<li>classNameId: identifica el tipo de contenido. Es el identificador de la clase asociado al contenido, se encuentra representado mediante la entidad ClassName y la tabla classname_.</li>
</ul>
<ul>
<li>classPK: identifica el contenido específico asociado al asset. Suele ser la clave primaria de la tabla donde se almacena el contenido.</li>
</ul>
El concepto asset se encuentra estrechamente relacionado con el concepto de categoría y etiqueta. Efectivamente, en la base de datos de Liferay se encuentran dos tablas que definen esa relación:
<ul>
<li>assetentries_assetcategories.</li>
<li>assetentries_assettags.</li>
</ul>
La clase AssetEntryLocalServiceUtil proporciona los métodos que nos permitirán manejar estos contenidos, recuperándolos, editándolos, etc.
El ejemplo que se muestra a continuación ilustra lo anteriormente comentado:
<pre>
int total =
AssetEntryLocalServiceUtil.getAssetEntriesCount();
List <AssetEntry> contenidos = AssetEntryLocalServiceUtil.getAssetEntries(0,total);

for(int i=0;i<contenidos.size();i++){

AssetEntry c = contenidos.get(i);
...
}
</pre>
Una vez definidos AssetEntry y de AssetEntryLocalServiceUtil, se pasa a describir uno de los tipos de contenidos más utilizados, los contenidos web.
<h1>Contenidos web</h1>
<h2>Introducción</h2>
Los contenidos web en Liferay son manejados mediante un conjunto de servicios y modelos y son almacenados en la base de datos en la tabla journalarticle. Sus campos más significativos son:
<ul>
<li>Identificador del contenido: articleId.</li>
<li>Título: title.</li>
<li>Descripción: description.</li>
<li>Identificador de la estructura asociada al contenido: structureId.</li>
<li>Identificador de la plantilla asociada al contenido: templateId.</li>
<li>Identificador de grupo: groupId.</li>
<li>Identificador de usuario: userId.</li>
<li>Información del contenido: content.</li>
</ul>
Un contenido web en Liferay es un objeto que implementa la interface JournalArticle que se encuentra en el paquete com.liferay.portlet.journal.model:
<img width="634" height="222" alt="" src="/userfiles/2(4).jpg" />
Son manejados mediante la clase JournalArticleLocalServiceUtil.
<pre>
List<JournalArticle> lista = JournalArticleLocalServiceUtil.getArticles(scopeGroupId);

for(int i=0;i<lista.size();i++){
JournalArticle journalArticle = lista.get(i);
...
</pre>
Esta clase proporciona métodos para recuperar, actualizar, borrar y buscar contenidos web, de la misma forma en la que lo hacen todos los servicios de Liferay. A continuación, pasamos a describir alguna de las operaciones más habituales.
<h2>Mostrando contenidos</h2>
¿La entidad JournalArticle tiene acceso a la información del contenido web? ¿El método getContent() me permite recuperar el contenido del contenido web? ¿Esto tiene que ver con estructuras y plantillas?
Vamos a intentar aclarar estas preguntas a continuación.
<h3>Trabajando con plantillas y estructuras</h3>
Cuando se crea un contenido web con una estructura y una plantilla específicas, el proceso para mostrar el contenido web es algo diferente. 
El método getContent() de la interface JournalArticle NO es válido. 
Para mostrar el contenido generado como resultado de la aplicación de una estructura y una plantilla específicas aparece la entidad JournalArticleDisplay.
La interface JournalArticleDisplay y su método getContent() muestra el contenido web tras la aplicación de su estructura y plantilla asociada.
<h1 class="rtecenter"><img width="470" height="221" src="/userfiles/6(1).jpg" alt="" /></h1>
Por ejemplo:
<pre>
// Paso 1: Se recuperan todos los contenidos web
// que se encuentran en la comunidad donde se ha
// desplegado el portlet.
List<JournalArticle> lista = JournalArticleLocalServiceUtil.getArticles(scopeGroupId);
for(int i=0;i<lista.size();i++){
// Paso 2: Se recupera el articulo que se desea
// mostrar.
JournalArticle journalArticle = lista.get(i);
// Paso 3: Se recupera el idioma utilizado.
String languageId =
LanguageUtil.getLanguageId(request);
// Paso 4: Se recupera el objeto JournalArticleDisplay
JournalArticleDisplay articleDisplay =
JournalArticleLocalServiceUtil.getArticleDisplay(
journalArticle,
null,
null,
languageId, 1, null, themeDisplay);
</pre>
Una vez recuperado el objeto de tipo JournalArticleDisplay asociado a un determinado artículo, se podrá mostrar en cualquier página, tal que así:
<pre>
...
<div>
<%= articleDisplay.getContent() %>
</div>
...
</pre>
<h2>Extracción de campos específicos</h2>
¿Cómo se pueden recuperar campos específicos de un contenido web para procesarlos de forma independiente?
 
¿JournalArticle o JournalArticleDisplay?
Como se ha visto en el ejemplo anterior, la información asociada a un contenido web puede recuperarse a través del objeto de tipo JournalArticleDisplay, pero cuando necesito manejar parte de la información almacenada en el contenido, ¿qué puedo hacer? A continuación, se muestra una solución a este problema:
<pre>
/*
* En este ejemplo se supone que el contenido
* esta asociado a una plantilla o estructura con un
* campo llamado title.
*/

String contenidoArticulo = journalArticle.
getContentByLocale(themeDisplay.getLanguageId());
Document documento = null;
String title=null;
String summary = null;
try{
documento = SAXReaderUtil.read(
new StringReader(contenidoArticulo));

Node node1 = documento.selectSingleNode(
"/root/dynamic-element[@name='title']/dynamic- content");

if (node1!=null && node1.getText().length() > 0) {
title = node1.getText();
}
...
</pre>
<h2>¿Para qué trabajar con Assets?</h2>
Cuando trabajamos con contenidos web, ¿necesitamos incorporar el concepto Asset en algún momento? ¿Por qué existe esta entidad? Debe haber alguna razón. La respuesta es clara: categorías y etiquetas. 
Es IMPORTANTE tener claro que la gestión de assets nos permite relacionar cualquier tipo de contenido con categorías y etiquetas, de cualquier otra forma sería imposible.
<h2>Gestión de assets</h2>
Para manejar assets se trabaja con las clases utility AssetEntryLocalServiceUtil y AssetEntryServiceUtil. Nos proporcionan los métodos habituales para manejar este tipo de entidades: add, create, delete, update, get, ... 
Los procesos de búsqueda pueden llevarse a cabo de forma específica mediante el método getEntries:
<pre>
public static List<AssetEntry>
getEntries(AssetEntryQuery entryQuery)
throws SystemException
</pre>
Por ejemplo:
<pre>
int total = AssetEntryLocalServiceUtil.getAssetEntriesCount();
List <AssetEntry> contenidos = AssetEntryLocalServiceUtil.getAssetEntries(0,total); for(int i=0;i<contenidos.size();i++){
AssetEntry c = contenidos.get(i);
}
</pre>
<h2>Consultas sobre Assets</h2>
El método getEntries asociado al servicio AssetEntryLocalServiceUtil es de vital importancia a la hora de llevar a cabo consultas:
<pre>
public static List<AssetEntry>
getEntries(AssetEntryQuery entryQuery)
throws SystemException
</pre>
Recibe como parámetro una consulta y devuelve como valor de retorno una lista de contenido que cumple dicha consulta. Ahora bien, ¿cómo se construye ésta?
La clase AssetEntryQuery nos permite realizar consultas avanzadas sobre los diferentes assets almacenados en la instalación. Los métodos set nos permiten definir los criterios de búsqueda, por ejemplo:
<ul>
<li>public void setGroupIds(long[] groupIds): comunidades donde se han creado los contenidos.</li>
<li>public void setClassName(String className): tipo de contenido.</li>
<li>public void setAllCategoryIds(long[] allCategoryIds): contenidos con las siguientes categorías.</li>
<li>public void setAllTagIds(long[] allTagIds): contenidos con todas las etiquetas.</li>
<li>...</li>
</ul>
Para ilustrar esta funcionalidad, se muestra a continuación el siguiente trozo de código:
<pre>
...
// Paso 1: Se construye la consulta gracias a la clase // AssetEntryQuery.
AssetEntryQuery consulta = new AssetEntryQuery();

// Paso 2: Se inicializa la consulta.
// Paso 2.1: Comunidades donde se quiere realizar la // busqueda.

// Nota: idsComunidades es un array de tipo long
// que ha sido creado previamente con los identificadores
// de cada comunidad
consulta.setGroupIds(idsComunidades);

// Paso 2.2: Rango de documentos.
consulta.setStart(0);
consulta.setEnd(numNoticias);

// Paso 2.3: Tipo de contenido que se quiere modificar: // Contenido web.

// Se obtiene el identificador unico del className
// asociado al tipo contenido web.
ClassName nombre = ClassNameLocalServiceUtil.
getClassName(
"com.liferay.portlet.journal.model.JournalArticle");
long classNameIdJournal = nombre.getClassNameId();

long[] tipos = {classNameIdJournal};

// El metodo setClassNameIds nos permite indicar los
// tipos de contenidos que quiere manejar.
consulta.setClassNameIds(tipos);

// Paso 2.4: Categorias asocidas a los contenidos web // que se quieren recuperar
// Nota: categoryIds es un array de tipo long creado
// previamente donde se almacenan los ids de las
// categorias a partir de las cuales se realiza
// la busqueda.
consulta.setAllCategoryIds(categoryIds);

// Paso 3: Una vez creada la query, gracias al metodo
// getEntries se ejecuta la consulta de busqueda.
List<AssetEntry> resultados =
AssetEntryLocalServiceUtil.getEntries(consulta);

</pre>
<h1>AssetEntry vs JournalArticle</h1>
Una vez que se recuperan los assets asociados a una consulta ... 
¿Cómo recupero los contenidos web asociados?
<img width="141" height="184" src="/userfiles/7(1).jpg" alt="" />
La relacion entre JournalArticle y AssetEntry se define mediante una entidad llamada JournalArticleResource:
<img width="579" height="173" src="/userfiles/8(1).jpg" alt="" />
La entidad AssetEntry tiene un campo llamado classPK. Este campo permite relacionar ambas entidades mediante el método getArticleResource()
<pre>
...
AssetEntry e = ...;
JournalArticleResource recurso = JournalArticleResourceLocalServiceUtil.
getArticleResource(e.getClassPK());

JournalArticle articulo =
JournalArticleLocalServiceUtil.getArticle(
e.getGroupId(), recurso.getArticleId());
</pre>
<h1>Conclusión</h1>
Si el programador es capaz de manejar los conceptos tratados en este artículo, no tendrá ningún problema a la hora de extender los portlets del core Liferay que se encargan de manejar contenidos, por ejemplo:
<ul>
<li>Asset Publisher.</li>
<li>Display Content.</li>
<li>...</li>
</ul>
Lógicamente, también podrá crear nuevos portlets que trabajen con cualquier tipo de contenido.

Drupal theme by Kiwi Themes.

Enlaces primarios

Programando contenidos en Liferay 6

Sindicar

Entradas recientes en bitácoras

Comentarios recientes

Bitácoras

Buscar

Inicio de sesión

Navegación