Asistencia al usuario para autores de contenido

Contexto de representación de listas

Aprenda a crear un contexto de representación de listas.

En IBM® Digital Data Connector (DDC) for WebSphere Portal, el contexto de representación de listas representa un objeto de datos agregado. Los plug-ins de DDC pueden utilizar el objeto de datos para determinar los datos que se cargan y cómo filtrarlos y ordenarlos. Puede crear un contexto de representación de listas añadiendo una etiqueta [Plugin:ListRenderingContext] a los diseños de Web Content Manager. Los componentes del contenido de contexto se completan automáticamente mediante la infraestructura de DDC. Estos componentes incluyen los parámetros de solicitud de portlet actual y la respuesta, y la representación de Digital Data Connector pública. Se deben especificar otros componentes mediante los parámetros de la etiqueta Plugin:ListRenderingContext. La sintaxis general de la etiqueta es la siguiente:
[Plugin:ListRenderingContext action=”” extension-id=”” profile=””attribute=”” 
                             key=”” format=”” separator=”” escape=”” prefix]
Los parámetros se describen en la lista siguiente:
action
Este parámetro es obligatorio. Utilice este parámetro para identificar la acción que desea que se ejecute. Los valores soportados son los siguientes:
set
Utilice este valor para establecer un nuevo contexto de representación de listas. Puede anidar los contextos de representación de listas. Si especifica este valor, también necesita establecer el parámetro extension-id.
remove
Utilice este valor para eliminar el contexto de representación de listas actual. Si este contexto de representación de listas era un contexto de representación de listas anidado, el contexto de representación de listas exterior pasará a estar activo de nuevo.
getListProperty
Utilice este valor para extraer propiedades de la lista de beans que se hubiera cargado para el contexto de representación de listas actual.
getAttribute
Utilice este valor para extraer atributos individuales que haya especificado al crear el contexto de representación de listas actual.
getFilter
Utilice este valor para recuperar el valor de un parámetro de representación público del filtro DDC específico.
reloadProfiles
Utilice este valor para borrar todas las memorias cachés relacionadas con DDC y volver a cargar todos los perfiles de representación de listas. Este parámetro puede ser útil en entornos de desarrollo para activar modificaciones en perfiles de representación de listas desplegadas.
clearCaches
Utilice este valor para borrar todas las memorias caché relacionadas con DDC. Este parámetro puede ser útil en entornos de desarrollo para analizar problemas de almacenamiento en memoria caché.
exceptionOccured
Utilice este valor para comprobar si se ha producido una excepción durante el cálculo de la lista de beans. El portlet Visor de contenido web representa el contenido del código de plugin ListRenderingContext solamente con esta acción si se ha producido una excepción al procesar el contexto de representación de listas actual.
getExceptionMessage
Utilice este valor para recuperar el mensaje de una excepción que se ha producido durante el cálculo de la lista de beans.
extension-id
Utilice este parámetro para identificar el plug-in de DDC específico que desea que maneje este contexto. Este parámetro es obligatorio con el valor action="set". Para tratar el plug-in de DDC XML genérico, especifique el valor ibm.portal.ddc.xml.
profile
Utilice este parámetro para identificar el perfil de representación de listas que desea que se utilice. Este parámetro sólo será efectivo junto con el valor action="set". Este parámetro es obligatorio al tratar el plug-in de DDC XML genérico en el parámetro extension-id.
attribute
Utilice este parámetro como un atributo con varios valores que puede utilizar para añadir información adicional al contexto de representación de listas. Este parámetro sólo será relevante para el valor action="set". El plug-in de DDC XML genérico da soporte a un conjunto de atributos. Para obtener detalles sobre estos atributos, consulte Plug-in de Digital Data Connector XML genérico.
key
Utilice este parámetro para identificar un atributo específico o una propiedad de lista que desee que se grabe en la marcación. Este parámetro será relevante sólo para los valores action="getListProperty" y action="getAttribute".
format
Utilice este parámetro para especificar el formato que desee que se utilice cuando el plug-in grabe propiedades de listas de tipo Date en la marcación. Este parámetro será relevante sólo para el valor action="getListProperty".
separator
Utilice este parámetro para especificar el fragmento de marcación que desee que se grabe en la marcación entre los elementos de una propiedad de lista de varios valores. El valor predeterminado es una coma ( , ). Este parámetro será relevante sólo para el valor action="getListProperty".
escape
Utilice este parámetro para especificar el escape que desee aplicar para la marcación que genera el plug-in. Los valores soportados son los siguientes: xml, json, javascript y none. El valor predeterminado es none. Este parámetro será relevante únicamente para action="getListProperty", action="getAttribute", action="getFilter" y action="getExceptionMessage".
prefix
Utilice este parámetro para especificar el prefijo para el parámetro filter public render de DDC que desee recuperar. Este parámetro sólo es relevante para action="getFilter".
En la tabla siguiente se muestran cuáles son las acciones que soportan los parámetros y si son o no obligatorias.
Tabla 1. Qué parámetros son obligatorios, y a qué acciones dan soporte
Parámetro El parámetro es relevante para estas acciones El parámetro es obligatorio con las acciones de la columna anterior
action N/D N/D
extension-id set yes
profile set Si el parámetro profile es obligatorio o no depende del valor para el parámetro extension-id. Si trata el plug-in de DDC XML genérico, el parámetro profile es obligatorio.
attribute set no
key getListProperty, getAttribute yes
format getListProperty no
separator getListProperty, getFilter no
escape getListProperty, getAttribute, getFilter no
Para ver ejemplos sobre cómo establecer el contexto de representación de listas, consulte los temas siguientes.