Package com.day.cq.reporting.helpers

Class Const

  • public class Const
extends java.lang.Object
    This class provides several constants to be used in the context of reporting.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NN_COL_SORTING
      path from a column's setting to the sorting subnode
      static java.lang.String NN_COLDEFS
      Name of the node that contains column definitions (used by the column's component node)
      static java.lang.String NN_COLUMNS
      Name of the node that contains the columns of a report (relative to the report's component node)
      static java.lang.String NN_DATA
      Name of the root node for data-related configuration
      static java.lang.String NN_DEFAULTS
      Name of the node that contains the default settings of a column (used by the column's component node)
      static java.lang.String NN_DPP_AGGREGATED
      Name of the sub-node that contains the data processor for aggregated state
      static java.lang.String NN_FILTERS
      Name of the root node for filter configuration/definition
      static java.lang.String NN_GENERIC
      Name of generic config node
      static java.lang.String NN_PREPROCESSING
      Name of the root node for data preprocessing definitions
      static java.lang.String NN_PROP_CONSTRAINTS
      Name of the node that defines property constraints
      static java.lang.String NN_QUERYBUILDER
      Name of query builder-related config nodes
      static java.lang.String NN_RESOLVER_CONFIG
      Name of the node that may contain additional resolver configuration
      static java.lang.String NN_SETTINGS
      Name of the node that contains the column settings (used by the column's instance node)
      static java.lang.String NN_SNAPSHOT_DATA
      Node name: Snapshot data
      static java.lang.String NN_SNAPSHOT_TOTALS
      Node name: Totals for data columns of a snapshot
      static java.lang.String NN_SNAPSHOT_TYPEINFO
      Node name: Type info for snapshot
      static java.lang.String NT_FROZEN_REPORT
      Node type for frozen reports
      static java.lang.String PATH_COL_FILTERS
      Path to a column component's filter settings
      static java.lang.String PATH_COL_QUERYBUILDER
      Path to a column component's query builder settings
      static java.lang.String PATH_DATA
      Path to a column component's data settings
      static java.lang.String PATH_PREPROCESSING
      Path to a column's preprocessing data configuration
      static java.lang.String PATH_REP_QUERYBUILDER
      Path to a report's query builder settings
      static java.lang.String PMODE_SERVER
      Processing mode: Serverside
      static java.lang.String PMODE_SERVER_INTERACTIVE
      Processing mode: Serverside; interactive mode
      static java.lang.String PN_AGGREGATE
      Name of the property that defines a column's aggregate type by default
      static java.lang.String PN_COL_ISSORTED
      Name of the property that determines if a column is sorted
      static java.lang.String PN_COL_SORTDIR
      Name of the property that determines the sorting direction (if sorted) of a column
      static java.lang.String PN_DATA_CUSTOM_ROOT
      Name of the property that determines the custom root path of a report's data
      static java.lang.String PN_DATA_FLATNESS
      Name of the property that determines the path flatness of a report
      static java.lang.String PN_DATA_ROOT
      Name of the property that determines the root path of a report's data
      static java.lang.String PN_DPP_FORMAT
      Name of the property that contains the data format for a data preprocessor
      static java.lang.String PN_DPP_REGEX_PATTERN
      Name of the property that contains the regex pattern for a data preprocessor
      static java.lang.String PN_DPP_REGEX_REPLACE
      Name of the property that contains the replace string/pattern for a data preprocessor
      static java.lang.String PN_FILTER_ACTIVE
      Name of the property that defines if a filter is active
      static java.lang.String PN_FILTER_ID
      Name of the property that defines a filter's ID (used for internal referencing
      static java.lang.String PN_FILTER_TYPE
      Name of the property that defines a filter's type
      static java.lang.String PN_FILTER_VALUE
      Name of the property that defines the filter value (format is specific for the implementing filter)
      static java.lang.String PN_FILTERING_PHASE
      Name of the property that defines the phase the filter is bound to
      static java.lang.String PN_IS_GROUPABLE
      Name of the property that defines if the column is groupable
      static java.lang.String PN_IS_GROUPED
      Name of the property that defines if a column is grouped
      static java.lang.String PN_MANDATORY_PROPS
      Name of the property that defines properties that are required for a node to be included in result sets
      static java.lang.String PN_NODETYPES
      Name of the property that defines the node types to be included in result sets
      static java.lang.String PN_PROPNAME
      Name of properties that define a property name
      static java.lang.String PN_PROPVALUE
      Name of properties that define a property value
      static java.lang.String PN_REPORT_CLASS
      Name of the property that determines the class of a report
      static java.lang.String PN_REPORTING_VERSION
      Name of the property (on the report node) that holds the version of reporting the report was created for
      static java.lang.String PN_RESOLVER
      Name of the property that defines a resolver to be used for the column's values.
      static java.lang.String PN_RESOLVER_I18N
      Name of the property that may define if a resolved value has to be internationalized
      static java.lang.String PN_RESOLVER_PATH
      Name of the property that may contain a path used by a resolver
      static java.lang.String PN_RESOLVER_PROPERTY_NAME
      Name of the property that may contain a property name used by a resolver
      static java.lang.String PN_RESOLVER_SUB_PATH
      Name of the property that may contain a sub path used by a resolver
      static java.lang.String PN_SECONDARY_VALUE_PROPERTY
      Name of the property that defines the property name(s) to get secondary data from
      static java.lang.String PN_SECONDARY_VALUE_SUBPATH
      Name of the property that defines the subpath to get the data from
      static java.lang.String PN_SERVER_PROCMODE
      Name of the property (on the report node) that defines the current server processing mode
      static java.lang.String PN_SNAPSHOT_DATA_COLS
      Property name: Data column names (type info)
      static java.lang.String PN_SNAPSHOT_DATA_SORTING
      Property name: Data column sorting (type info)
      static java.lang.String PN_SNAPSHOT_DATA_TITLES
      Property name: Data column titles (type info)
      static java.lang.String PN_SNAPSHOT_DATA_TYPES
      Property name: Data column types (type info)
      static java.lang.String PN_SNAPSHOT_GROUPED_COLS
      Property name: Grouped column names (type info)
      static java.lang.String PN_SNAPSHOT_GROUPED_TITLES
      Property name: Grouped column titles (type info)
      static java.lang.String PN_SNAPSHOT_GROUPED_TYPES
      Property name: Grouped column types (type info)
      static java.lang.String PN_SNAPSHOT_HAS_GROUPED_COLS
      Property name: Flag if snapshot contains grouped columns; false, if no data is available
      static java.lang.String PN_SNAPSHOT_REPORT_DATAID
      Name of the property (on the report node) that holds a unique identifier to separate the different versions of a report
      static java.lang.String PN_SNAPSHOT_REPORT_PATH
      Name of the property (on the report node) that holds the path of the versioned report node that contains the definition snapshots are currently taken for
      static java.lang.String PN_SNAPSHOT_RUNNER
      Name of the property (on finished report nodes) that defines the user to be used for taking snapshots
      static java.lang.String PN_SNAPSHOT_TIME
      Property name: Time of a snapshot
      static java.lang.String PN_SNAPSHOTS
      Name of the property (on the report node) that defines the current snapshot mode of the report
      static java.lang.String PN_TREETRAVERSAL
      Name of the property that defines if tree traversal be done instead of query for result sets
      static java.lang.String PN_TYPE
      Name of the property that defines a column's value type
      static java.lang.String PN_VALUE_PROPERTY
      Name of the property that defines the property name(s) to get the data from
      static java.lang.String PN_VALUE_SUBPATH
      Name of the property that defines the subpath to get the data from
      static java.lang.String RENDER_TYPE_CHART
      Selector for rendering a chart view only
      static java.lang.String RENDER_TYPE_TABULAR
      Selector for rendering the tabular view only

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • PN_AGGREGATE

        public static final java.lang.String PN_AGGREGATE
        Name of the property that defines a column's aggregate type by default
        See Also:
        Constant Field Values

      • PN_TYPE

        public static final java.lang.String PN_TYPE
        Name of the property that defines a column's value type
        See Also:
        Constant Field Values

      • PN_IS_GROUPED

        public static final java.lang.String PN_IS_GROUPED
        Name of the property that defines if a column is grouped
        See Also:
        Constant Field Values

      • PN_REPORT_CLASS

        public static final java.lang.String PN_REPORT_CLASS
        Name of the property that determines the class of a report
        See Also:
        Constant Field Values

      • PN_DATA_ROOT

        public static final java.lang.String PN_DATA_ROOT
        Name of the property that determines the root path of a report's data
        See Also:
        Constant Field Values

      • PN_DATA_CUSTOM_ROOT

        public static final java.lang.String PN_DATA_CUSTOM_ROOT
        Name of the property that determines the custom root path of a report's data
        See Also:
        Constant Field Values

      • PN_DATA_FLATNESS

        public static final java.lang.String PN_DATA_FLATNESS
        Name of the property that determines the path flatness of a report
        See Also:
        Constant Field Values

      • PN_VALUE_SUBPATH

        public static final java.lang.String PN_VALUE_SUBPATH
        Name of the property that defines the subpath to get the data from
        See Also:
        Constant Field Values

      • PN_VALUE_PROPERTY

        public static final java.lang.String PN_VALUE_PROPERTY
        Name of the property that defines the property name(s) to get the data from
        See Also:
        Constant Field Values

      • PN_SECONDARY_VALUE_SUBPATH

        public static final java.lang.String PN_SECONDARY_VALUE_SUBPATH
        Name of the property that defines the subpath to get the data from
        See Also:
        Constant Field Values

      • PN_SECONDARY_VALUE_PROPERTY

        public static final java.lang.String PN_SECONDARY_VALUE_PROPERTY
        Name of the property that defines the property name(s) to get secondary data from
        See Also:
        Constant Field Values

      • PN_IS_GROUPABLE

        public static final java.lang.String PN_IS_GROUPABLE
        Name of the property that defines if the column is groupable
        See Also:
        Constant Field Values

      • PN_RESOLVER

        public static final java.lang.String PN_RESOLVER
        Name of the property that defines a resolver to be used for the column's values.
        See Also:
        Constant Field Values

      • NN_RESOLVER_CONFIG

        public static final java.lang.String NN_RESOLVER_CONFIG
        Name of the node that may contain additional resolver configuration
        See Also:
        Constant Field Values

      • PN_RESOLVER_PATH

        public static final java.lang.String PN_RESOLVER_PATH
        Name of the property that may contain a path used by a resolver
        See Also:
        Constant Field Values

      • PN_RESOLVER_PROPERTY_NAME

        public static final java.lang.String PN_RESOLVER_PROPERTY_NAME
        Name of the property that may contain a property name used by a resolver
        See Also:
        Constant Field Values

      • PN_RESOLVER_SUB_PATH

        public static final java.lang.String PN_RESOLVER_SUB_PATH
        Name of the property that may contain a sub path used by a resolver
        See Also:
        Constant Field Values

      • PN_RESOLVER_I18N

        public static final java.lang.String PN_RESOLVER_I18N
        Name of the property that may define if a resolved value has to be internationalized
        See Also:
        Constant Field Values

      • NN_COL_SORTING

        public static final java.lang.String NN_COL_SORTING
        path from a column's setting to the sorting subnode
        See Also:
        Constant Field Values

      • PN_COL_ISSORTED

        public static final java.lang.String PN_COL_ISSORTED
        Name of the property that determines if a column is sorted
        See Also:
        Constant Field Values

      • PN_COL_SORTDIR

        public static final java.lang.String PN_COL_SORTDIR
        Name of the property that determines the sorting direction (if sorted) of a column
        See Also:
        Constant Field Values

      • NN_COLUMNS

        public static final java.lang.String NN_COLUMNS
        Name of the node that contains the columns of a report (relative to the report's component node)
        See Also:
        Constant Field Values

      • NN_COLDEFS

        public static final java.lang.String NN_COLDEFS
        Name of the node that contains column definitions (used by the column's component node)
        See Also:
        Constant Field Values

      • NN_DEFAULTS

        public static final java.lang.String NN_DEFAULTS
        Name of the node that contains the default settings of a column (used by the column's component node)
        See Also:
        Constant Field Values

      • NN_SETTINGS

        public static final java.lang.String NN_SETTINGS
        Name of the node that contains the column settings (used by the column's instance node)
        See Also:
        Constant Field Values

      • NN_GENERIC

        public static final java.lang.String NN_GENERIC
        Name of generic config node
        See Also:
        Constant Field Values

      • NN_QUERYBUILDER

        public static final java.lang.String NN_QUERYBUILDER
        Name of query builder-related config nodes
        See Also:
        Constant Field Values

      • NN_FILTERS

        public static final java.lang.String NN_FILTERS
        Name of the root node for filter configuration/definition
        See Also:
        Constant Field Values

      • NN_DATA

        public static final java.lang.String NN_DATA
        Name of the root node for data-related configuration
        See Also:
        Constant Field Values

      • NN_PREPROCESSING

        public static final java.lang.String NN_PREPROCESSING
        Name of the root node for data preprocessing definitions
        See Also:
        Constant Field Values

      • NN_PROP_CONSTRAINTS

        public static final java.lang.String NN_PROP_CONSTRAINTS
        Name of the node that defines property constraints
        See Also:
        Constant Field Values

      • PN_PROPNAME

        public static final java.lang.String PN_PROPNAME
        Name of properties that define a property name
        See Also:
        Constant Field Values

      • PN_PROPVALUE

        public static final java.lang.String PN_PROPVALUE
        Name of properties that define a property value
        See Also:
        Constant Field Values

      • PN_NODETYPES

        public static final java.lang.String PN_NODETYPES
        Name of the property that defines the node types to be included in result sets
        See Also:
        Constant Field Values

      • PN_TREETRAVERSAL

        public static final java.lang.String PN_TREETRAVERSAL
        Name of the property that defines if tree traversal be done instead of query for result sets
        See Also:
        Constant Field Values

      • PN_MANDATORY_PROPS

        public static final java.lang.String PN_MANDATORY_PROPS
        Name of the property that defines properties that are required for a node to be included in result sets
        See Also:
        Constant Field Values

      • PN_FILTER_ID

        public static final java.lang.String PN_FILTER_ID
        Name of the property that defines a filter's ID (used for internal referencing
        See Also:
        Constant Field Values

      • PN_FILTER_TYPE

        public static final java.lang.String PN_FILTER_TYPE
        Name of the property that defines a filter's type
        See Also:
        Constant Field Values

      • PN_FILTERING_PHASE

        public static final java.lang.String PN_FILTERING_PHASE
        Name of the property that defines the phase the filter is bound to
        See Also:
        Constant Field Values

      • PN_FILTER_ACTIVE

        public static final java.lang.String PN_FILTER_ACTIVE
        Name of the property that defines if a filter is active
        See Also:
        Constant Field Values

      • PN_FILTER_VALUE

        public static final java.lang.String PN_FILTER_VALUE
        Name of the property that defines the filter value (format is specific for the implementing filter)
        See Also:
        Constant Field Values

      • PN_DPP_REGEX_PATTERN

        public static final java.lang.String PN_DPP_REGEX_PATTERN
        Name of the property that contains the regex pattern for a data preprocessor
        See Also:
        Constant Field Values

      • PN_DPP_REGEX_REPLACE

        public static final java.lang.String PN_DPP_REGEX_REPLACE
        Name of the property that contains the replace string/pattern for a data preprocessor
        See Also:
        Constant Field Values

      • PN_DPP_FORMAT

        public static final java.lang.String PN_DPP_FORMAT
        Name of the property that contains the data format for a data preprocessor
        See Also:
        Constant Field Values

      • NN_DPP_AGGREGATED

        public static final java.lang.String NN_DPP_AGGREGATED
        Name of the sub-node that contains the data processor for aggregated state
        See Also:
        Constant Field Values

      • PN_SERVER_PROCMODE

        public static final java.lang.String PN_SERVER_PROCMODE
        Name of the property (on the report node) that defines the current server processing mode
        See Also:
        Constant Field Values

      • PN_SNAPSHOTS

        public static final java.lang.String PN_SNAPSHOTS
        Name of the property (on the report node) that defines the current snapshot mode of the report
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_REPORT_PATH

        public static final java.lang.String PN_SNAPSHOT_REPORT_PATH
        Name of the property (on the report node) that holds the path of the versioned report node that contains the definition snapshots are currently taken for
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_REPORT_DATAID

        public static final java.lang.String PN_SNAPSHOT_REPORT_DATAID
        Name of the property (on the report node) that holds a unique identifier to separate the different versions of a report
        See Also:
        Constant Field Values

      • PN_REPORTING_VERSION

        public static final java.lang.String PN_REPORTING_VERSION
        Name of the property (on the report node) that holds the version of reporting the report was created for
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_RUNNER

        public static final java.lang.String PN_SNAPSHOT_RUNNER
        Name of the property (on finished report nodes) that defines the user to be used for taking snapshots
        See Also:
        Constant Field Values

      • NN_SNAPSHOT_DATA

        public static final java.lang.String NN_SNAPSHOT_DATA
        Node name: Snapshot data
        See Also:
        Constant Field Values

      • NN_SNAPSHOT_TYPEINFO

        public static final java.lang.String NN_SNAPSHOT_TYPEINFO
        Node name: Type info for snapshot
        See Also:
        Constant Field Values

      • NN_SNAPSHOT_TOTALS

        public static final java.lang.String NN_SNAPSHOT_TOTALS
        Node name: Totals for data columns of a snapshot
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_TIME

        public static final java.lang.String PN_SNAPSHOT_TIME
        Property name: Time of a snapshot
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_GROUPED_COLS

        public static final java.lang.String PN_SNAPSHOT_GROUPED_COLS
        Property name: Grouped column names (type info)
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_GROUPED_TYPES

        public static final java.lang.String PN_SNAPSHOT_GROUPED_TYPES
        Property name: Grouped column types (type info)
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_GROUPED_TITLES

        public static final java.lang.String PN_SNAPSHOT_GROUPED_TITLES
        Property name: Grouped column titles (type info)
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_DATA_COLS

        public static final java.lang.String PN_SNAPSHOT_DATA_COLS
        Property name: Data column names (type info)
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_DATA_TYPES

        public static final java.lang.String PN_SNAPSHOT_DATA_TYPES
        Property name: Data column types (type info)
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_DATA_TITLES

        public static final java.lang.String PN_SNAPSHOT_DATA_TITLES
        Property name: Data column titles (type info)
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_DATA_SORTING

        public static final java.lang.String PN_SNAPSHOT_DATA_SORTING
        Property name: Data column sorting (type info)
        See Also:
        Constant Field Values

      • PN_SNAPSHOT_HAS_GROUPED_COLS

        public static final java.lang.String PN_SNAPSHOT_HAS_GROUPED_COLS
        Property name: Flag if snapshot contains grouped columns; false, if no data is available
        See Also:
        Constant Field Values

      • PATH_REP_QUERYBUILDER

        public static final java.lang.String PATH_REP_QUERYBUILDER
        Path to a report's query builder settings
        See Also:
        Constant Field Values

      • PATH_COL_QUERYBUILDER

        public static final java.lang.String PATH_COL_QUERYBUILDER
        Path to a column component's query builder settings
        See Also:
        Constant Field Values

      • PATH_COL_FILTERS

        public static final java.lang.String PATH_COL_FILTERS
        Path to a column component's filter settings
        See Also:
        Constant Field Values

      • PATH_DATA

        public static final java.lang.String PATH_DATA
        Path to a column component's data settings
        See Also:
        Constant Field Values

      • PATH_PREPROCESSING

        public static final java.lang.String PATH_PREPROCESSING
        Path to a column's preprocessing data configuration
        See Also:
        Constant Field Values

      • PMODE_SERVER

        public static final java.lang.String PMODE_SERVER
        Processing mode: Serverside
        See Also:
        Constant Field Values

      • PMODE_SERVER_INTERACTIVE

        public static final java.lang.String PMODE_SERVER_INTERACTIVE
        Processing mode: Serverside; interactive mode
        See Also:
        Constant Field Values

      • RENDER_TYPE_TABULAR

        public static final java.lang.String RENDER_TYPE_TABULAR
        Selector for rendering the tabular view only
        See Also:
        Constant Field Values

      • RENDER_TYPE_CHART

        public static final java.lang.String RENDER_TYPE_CHART
        Selector for rendering a chart view only
        See Also:
        Constant Field Values

      • NT_FROZEN_REPORT

        public static final java.lang.String NT_FROZEN_REPORT
        Node type for frozen reports
        See Also:
        Constant Field Values