SessionDoc

CER le permite producir documentación HTML relacionada con una sesión ("SessionDoc").

Esta documentación proporciona un registro de todos los objetos de regla creados durante la sesión y, cuando se utiliza conjuntamente con las pruebas, puede ser una potente ayuda de depuración.

Puede ser útil utilizar el punto de enlace tearDown de JUnit para forzar que todos los métodos de prueba de la clase de prueba produzcan su SessionDoc:

@Override
          protected void tearDown() throws Exception {
          /*
          * Escribir SessionDoc, en un directorio denominado como el
          * método de prueba.
          */
          final File sessionDocOutputDirectory =
          new File("./gen/sessiondoc/" + this.getName());
          sessionDoc.write(sessionDocOutputDirectory);

          super.tearDown();
          }

A continuación se muestra la página SessionDoc principal para una prueba testSelfMadeMillionaireScenario:

Figura 1. SessionDoc para la prueba testSelfMadeMillionaireScenario

Algunos detalles clave en esta página son:

• La fecha y hora en la que se ha creado el SessionDoc;
• Las estrategias con las que se ha creado la sesión;
• Una lista de conjuntos de reglas cuyos objetos de regla han sido capturados en el SessionDoc y
• Indicar si se incluyen enlaces "utilizado por".

Al pulsar en el enlace para el único conjunto de reglas FlexibleRetirementYearRuleSet, se muestran los objetos de regla:

Figura 2. Objetos de regla para el conjunto de reglas FlexibleRetirementYearRuleSet

Esta página muestra:

• Los objetos de regla "externos" (programa de arranque) creados por el código de cliente durante esta sesión (sólo se ha creado uno en la prueba); y
• Los objetos de regla "internos" creados por las reglas durante esta sesión (no se ha calculado ninguno para esta prueba).

Al pulsar en el enlace de detalles para el único objeto de regla FlexibleRetirementYear se muestra su SessionDoc:

Figura 3. SessionDoc para el objeto de regla FlexibleRetirementYear

En la parte superior (no se muestra) están los detalles de resumen para el objeto de regla y, a continuación, se lista cada atributo de regla en el objeto de regla, con los detalles siguientes:

• Nombre

  Nombre del atributo de regla;

• Tipo declarado

  Tipo del atributo de regla declarado en el conjunto de reglas. El valor de tiempo de ejecución real puede ser de un subtipo de este tipo declarado;

• Estado

  El estado del valor, es decir, si era:

  • CALCULATED

    Calculado por reglas;

  • SPECIFIED

    Especificado explícitamente por el código de cliente, sustituyendo cualquier cálculo definido o inicializado¹como parte de una expresión create;

  • NOT_YET_CALCULATED

    No especificado explícitamente, no calculado durante la ejecución de reglas (porque ningún otro cálculo o prueba ha solicitado nunca el valor); o

  • ERROR

    Se ha producido un error durante el cálculo del valor (consulte los registros de aplicación o la salida de consola para obtener detalles y la pila de cálculos del error).

• Valor

  Representación de visualización del valor. Si el valor no se ha calculado nunca (NOT_YET_CALCULATED) o es erróneo (ERROR), se visualizará "?". Si el valor es un objeto de regla, el valor se mostrará como un hiperenlace navegable para que pueda ver los detalles de dicho objeto de regla y

• Derivación

  La derivación de RuleDoc del atributo (sin enlaces). Para obtener más información sobre RuleDoc, consulte RuleDoc.

• Depende de

  Enlaces a los atributos que se han utilizado para calcular este valor.

• Utilizado por

  (Opcional) Enlaces a los atributos que utilizaban este valor al calcular sus valores.

En el caso de objetos de regla que están almacenados en tablas de base de datos de CER, puede crear SessionDoc para estos objetos de regla almacenados ejecutando la clase curam.creole.util.DumpOutRuleObjects, donde un único argumento es el nombre de un directorio en el que se debe crear el SessionDoc. El programa de utilidad DumpOutRuleObjects recupera todos los objetos de regla de las tablas de base de datos de CER y, por lo tanto, se "recuperará" la acción para cada objeto de regla externa. Los objetos de regla interna se crearán (porque no están almacenados) y por lo tanto mostrarán una acción de "creado".