Class EntityReportParameters

java.lang.Object
fr.becpg.repo.report.entity.EntityReportParameters

public class EntityReportParameters extends Object

EntityReportParameters class.

Version:
$Id: $Id
Author:
matthieu
  • Field Details

    • PARAM_COMPONENT_DATALISTS_TO_EXTRACT

      public static final String PARAM_COMPONENT_DATALISTS_TO_EXTRACT
      Constant PARAM_COMPONENT_DATALISTS_TO_EXTRACT="componentDatalistsToExtract"
      See Also:
    • PARAM_ENTITY_DATALISTS_TO_EXTRACT

      public static final String PARAM_ENTITY_DATALISTS_TO_EXTRACT
      Constant PARAM_ENTITY_DATALISTS_TO_EXTRACT="entityDatalistsToExtract"
      See Also:
    • PARAM_EXTRACT_IN_MULTILEVEL

      public static final String PARAM_EXTRACT_IN_MULTILEVEL
      Constant PARAM_EXTRACT_IN_MULTILEVEL="extractInMultiLevel"
      See Also:
    • PARAM_EXTRACT_NON_EFFECTIVE_COMPONENT

      public static final String PARAM_EXTRACT_NON_EFFECTIVE_COMPONENT
      Constant PARAM_EXTRACT_NON_EFFECTIVE_COMPONENT="extractNonEffectiveComponent"
      See Also:
    • PARAM_MAX_COMPOLIST_LEVEL_TO_EXTRACT

      public static final String PARAM_MAX_COMPOLIST_LEVEL_TO_EXTRACT
      Constant PARAM_MAX_COMPOLIST_LEVEL_TO_EXTRACT="maxCompoListLevelToExtract"
      See Also:
    • PARAM_EXTRACT_DATALIST_IMAGE

      public static final String PARAM_EXTRACT_DATALIST_IMAGE
      Constant PARAM_EXTRACT_DATALIST_IMAGE="extractDatalistImage"
      See Also:
    • JSON_PARAM_PARAMS

      private static final String JSON_PARAM_PARAMS
      Constant JSON_PARAM_PARAMS="params"
      See Also:
    • JSON_PARAM_PROP

      private static final String JSON_PARAM_PROP
      Constant JSON_PARAM_PROP="prop"
      See Also:
    • JSON_PARAM_PREFS

      private static final String JSON_PARAM_PREFS
      Constant JSON_PARAM_PREFS="prefs"
      See Also:
    • JSON_PROP_ID

      private static final String JSON_PROP_ID
      Constant JSON_PROP_ID="id"
      See Also:
    • JSON_PROP_VALUE

      private static final String JSON_PROP_VALUE
      Constant JSON_PROP_VALUE="value"
      See Also:
    • JSON_PROP_NODEREF

      private static final String JSON_PROP_NODEREF
      Constant JSON_PROP_NODEREF="nodeRef"
      See Also:
    • JSON_PARAM_ITERATIONKEY

      private static final String JSON_PARAM_ITERATIONKEY
      Constant JSON_PARAM_ITERATIONKEY="iterationKey"
      See Also:
    • JSON_PARAM_NAMEFORMAT

      private static final String JSON_PARAM_NAMEFORMAT
      Constant JSON_PARAM_NAMEFORMAT="nameFormat"
      See Also:
    • JSON_PARAM_TITLEFORMAT

      private static final String JSON_PARAM_TITLEFORMAT
      Constant JSON_PARAM_TITLEFORMAT="titleFormat"
      See Also:
    • logger

      private static org.apache.commons.logging.Log logger
      Constant logger
    • iterationKey

      private String iterationKey
    • preferences

      private Map<String,String> preferences
    • reportNameFormat

      private String reportNameFormat
    • reportTitleFormat

      private String reportTitleFormat
    • parameters

  • Constructor Details

    • EntityReportParameters

      public EntityReportParameters(EntityReportParameters config)

      Constructor for EntityReportParameters.

      Parameters:
      config - a EntityReportParameters object.
    • EntityReportParameters

      public EntityReportParameters()

      Constructor for EntityReportParameters.

  • Method Details

    • getPreferences

      public Map<String,String> getPreferences()

      Getter for the field preferences.

      Returns:
      a Map object.
    • setReportNameFormat

      public void setReportNameFormat(String reportNameFormat)

      Setter for the field reportNameFormat.

      Parameters:
      reportNameFormat - a String object.
    • setReportTitleFormat

      public void setReportTitleFormat(String reportTitleFormat)

      Setter for the field reportTitleFormat.

      Parameters:
      reportTitleFormat - a String object.
    • getReportNameFormat

      public String getReportNameFormat(String defaultNameFormat)

      Getter for the field reportNameFormat.

      Parameters:
      defaultNameFormat - a String object.
      Returns:
      a String object.
    • getReportTitleFormat

      public String getReportTitleFormat(String defaultTitleFormat)

      Getter for the field reportTitleFormat.

      Parameters:
      defaultTitleFormat - a String object.
      Returns:
      a String object.
    • getIterationKey

      public String getIterationKey()

      Getter for the field iterationKey.

      Returns:
      a String object.
    • setIterationKey

      public void setIterationKey(String iterationKey)

      Setter for the field iterationKey.

      Parameters:
      iterationKey - a String object.
    • getParameters

      Getter for the field parameters.

      Returns:
      a List object.
    • setParameters

      public void setParameters(List<EntityReportParameters.EntityReportParameter> parameters)

      Setter for the field parameters.

      Parameters:
      parameters - a List object.
    • isParametersEmpty

      public boolean isParametersEmpty()

      isParametersEmpty.

      Returns:
      a boolean.
    • isEmpty

      public boolean isEmpty()

      isEmpty.

      Returns:
      a boolean.
    • updateDataSource

      public void updateDataSource(org.dom4j.Element xmlDataSource)

      updateDataSource.

      Parameters:
      xmlDataSource - a Element object.
    • createFromJSON

      public static EntityReportParameters createFromJSON(String jsonString)

      createFromJSON.

      Parameters:
      jsonString - a String object.
      Returns:
      a EntityReportParameters object.
    • toJSONString

      public String toJSONString()

      toJSONString.

      Returns:
      a String object.
    • match

      public boolean match(EntityReportParameters source)

      match.

      Parameters:
      source - a EntityReportParameters object.
      Returns:
      a boolean.
    • toString

      public String toString()
      Overrides:
      toString in class Object