Class AbstractObjectBrowserTabTransform

    • Field Detail

      • folderImage

        public FormalParameter folderImage
        Indicates the image to use when displaying a folder.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgFolder

        protected java.lang.String _imgFolder
      • reportImage

        public FormalParameter reportImage
        Indicates the image to use when displaying a report.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgReport

        protected java.lang.String _imgReport
      • graphImage

        public FormalParameter graphImage
        Indicates the image to use when displaying a graph.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgGraph

        protected java.lang.String _imgGraph
      • gridGraphImage

        public FormalParameter gridGraphImage
        Indicates the image to use when displaying a grid and graph.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgGridGraph

        protected java.lang.String _imgGridGraph
      • cubeImage

        public FormalParameter cubeImage
        Indicates the image to use when displaying a cube.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgCube

        protected java.lang.String _imgCube
      • filterImage

        public FormalParameter filterImage
        Indicates the image to use when displaying a filter.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgFilter

        protected java.lang.String _imgFilter
      • attributeImage

        public FormalParameter attributeImage
        Indicates the image to use when displaying an attribute.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgAttribute

        protected java.lang.String _imgAttribute
      • _imgRa

        protected java.lang.String _imgRa
      • attributeFormImage

        public FormalParameter attributeFormImage
        Indicates the image to use when displaying an attribute form.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgAttributeForm

        protected java.lang.String _imgAttributeForm
      • derivedMetricImage

        public FormalParameter derivedMetricImage
        Indicates the image to use when displaying a derived metric.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgDerivedMetric

        protected java.lang.String _imgDerivedMetric
      • metricImage

        public FormalParameter metricImage
        Indicates the image to use when displaying a metric.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgMetric

        protected java.lang.String _imgMetric
      • metricDmxImage

        public FormalParameter metricDmxImage
        Indicates the image to use when displaying a Predictive metric.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgMetricDmx

        protected java.lang.String _imgMetricDmx
      • consolidationImage

        public FormalParameter consolidationImage
        Indicates the image to use when displaying a consolidation.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgConsolidation

        protected java.lang.String _imgConsolidation
      • customGroupImage

        public FormalParameter customGroupImage
        Indicates the image to use when displaying a custom group.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgCustomGroup

        protected java.lang.String _imgCustomGroup
      • hierarchyImage

        public FormalParameter hierarchyImage
        Indicates the image to use when displaying a hierarchy.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgHierarchy

        protected java.lang.String _imgHierarchy
      • promptImage

        public FormalParameter promptImage
        Indicates the image to use when displaying a prompt.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgPrompt

        protected java.lang.String _imgPrompt
      • objectTypesFilter

        public FormalParameter objectTypesFilter
        Indicates the filter specification for the object types that should not be displayed.
        This filter is applied on top of whatever filter used in the bean when obtaining the information. Usage:
        The value to specify for this formal parameter should be a list of numeric object types, separated by commas, with the ones that should not be displayed when transforming the bean. For example, "3,4", indicates reports (EnumDSSXMLObjectTypes.DssXmlTypeReportDefinition) and metrics EnumDSSXMLObjectTypes.DssXmlTypeMetric) should not be displayed if found on the collection of objects to display.
      • objectSubtypesFilter

        public FormalParameter objectSubtypesFilter
        Indicates the filter specification for the object subtypes that should not be displayed.
        This filter is applied on top of whatever filter used in the bean when obtaining the information. Usage:
        The value to specify for this formal parameter should be a list of numeric object subtypes, separated by commas, with the ones that should not be displayed when transforming the bean. For example, "257,769", indicates custom groups (EnumDSSXMLObjectSubTypes.DssXmlSubTypeCustomGroup) and graphs EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportGraph) should not be displayed if found on the collection of objects to display.
      • FP_FOLDER_IMAGE

        public static final java.lang.String FP_FOLDER_IMAGE
        Constant specifying the name of the formal parameter for defining the folder image. Value is folderImage.
        See Also:
        Constant Field Values
      • FP_REPORT_IMAGE

        public static final java.lang.String FP_REPORT_IMAGE
        Constant specifying the name of the formal parameter for defining the report image. Value is reportImage.
        See Also:
        Constant Field Values
      • FP_GRAPH_IMAGE

        public static final java.lang.String FP_GRAPH_IMAGE
        Constant specifying the name of the formal parameter for defining the report image. Value is graphImage.
        See Also:
        Constant Field Values
      • FP_GRID_GRAPH_IMAGE

        public static final java.lang.String FP_GRID_GRAPH_IMAGE
        Constant specifying the name of the formal parameter for defining the report image. Value is gridGraphImage.
        See Also:
        Constant Field Values
      • FP_CUBE_IMAGE

        public static final java.lang.String FP_CUBE_IMAGE
        Constant specifying the name of the formal parameter for defining the cube image. Value is cubeImage.
        See Also:
        Constant Field Values
      • FP_FILTER_IMAGE

        public static final java.lang.String FP_FILTER_IMAGE
        Constant specifying the name of the formal parameter for defining the filter image. Value is filterImage.
        See Also:
        Constant Field Values
      • FP_ATTRIBUTE_IMAGE

        public static final java.lang.String FP_ATTRIBUTE_IMAGE
        Constant specifying the name of the formal parameter for defining the attribute image. Value is attributeImage.
        See Also:
        Constant Field Values
      • FP_RA_IMAGE

        public static final java.lang.String FP_RA_IMAGE
        Constant specifying the name of the formal parameter for defining the recursive attribute image. Value is raImage.
        See Also:
        Constant Field Values
      • FP_ATTRIBUTE_FORM_IMAGE

        public static final java.lang.String FP_ATTRIBUTE_FORM_IMAGE
        Constant specifying the name of the formal parameter for defining the attribute form image. Value is attributeFormImage.
        See Also:
        Constant Field Values
      • FP_METRIC_IMAGE

        public static final java.lang.String FP_METRIC_IMAGE
        Constant specifying the name of the formal parameter for defining the metric image. Value is metricImage.
        See Also:
        Constant Field Values
      • FP_DERIVED_METRIC_IMAGE

        public static final java.lang.String FP_DERIVED_METRIC_IMAGE
        Constant specifying the name of the formal parameter for defining the derived metric image. Value is derivedMetricImage.
        See Also:
        Constant Field Values
      • FP_METRIC_DMX_IMAGE

        public static final java.lang.String FP_METRIC_DMX_IMAGE
        Constant specifying the name of the formal parameter for defining the derived metric image. Value is derivedMetricImage.
        See Also:
        Constant Field Values
      • FP_CONSOLIDATION_IMAGE

        public static final java.lang.String FP_CONSOLIDATION_IMAGE
        Constant specifying the name of the formal parameter for defining the consolidation image. Value is consolidationImage.
        See Also:
        Constant Field Values
      • FP_CUSTOM_GROUP_IMAGE

        public static final java.lang.String FP_CUSTOM_GROUP_IMAGE
        Constant specifying the name of the formal parameter for defining the custom group image. Value is customGroupImage.
        See Also:
        Constant Field Values
      • FP_HIERARCHY_IMAGE

        public static final java.lang.String FP_HIERARCHY_IMAGE
        Constant specifying the name of the formal parameter for defining the hierarchy image. Value is hierarchyImage.
        See Also:
        Constant Field Values
      • FP_PROMPT_IMAGE

        public static final java.lang.String FP_PROMPT_IMAGE
        Constant specifying the name of the formal parameter for defining the prompt image. Value is promptImage.
        See Also:
        Constant Field Values
      • FP_OBJECT_TYPES_FILTER

        public static final java.lang.String FP_OBJECT_TYPES_FILTER
        Constant specifying the name of the formal parameter for defining the object types to consider for the filter. Value is objectTypesFilter.
        See Also:
        Constant Field Values
      • FP_OBJECT_SUBTYPES_FILTER

        public static final java.lang.String FP_OBJECT_SUBTYPES_FILTER
        Constant specifying the name of the formal parameter for defining the object subtypes to consider for the filter. Value is objectSubtypesFilter.
        See Also:
        Constant Field Values
      • FP_INCLUDE_DYNAMIC_SCRIPT

        public static final java.lang.String FP_INCLUDE_DYNAMIC_SCRIPT
        Constant specifying the name of the formal parameter for specifying whether to include dynamic scripts or not. Value is includeDynamicScript.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AbstractObjectBrowserTabTransform

        public AbstractObjectBrowserTabTransform()
        Default no-argument constructor. Initializes formal parameters.
    • Method Detail

      • isTransformEnabled

        public boolean isTransformEnabled()
        Indicates if the transform can be performed for the current state of the bean. If there's a case where the bean might be ready but the information it gets does not match what the transform expects, the rendering process might be stopped here. The outcome will be the component not being rendered at all (which can be logged as a warning for future investigation).
        Returns:
        True if it's possible to use the transform for rendering the bean. Otherwise, returns False
      • initializeImages

        public void initializeImages()
        Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.
        Overrides:
        initializeImages in class AbstractAppTransform
      • getJavascriptTyAttribute

        protected java.lang.String getJavascriptTyAttribute​(WebObjectInfo object)
        Return the Javascript TY attribute to use for the generation of the HTML tag related with this object.
        Parameters:
        object - The WebObjectInfo for which it's ty attribute name is requested.
        Returns:
        The Javascript TY attribute to use for the generation of the HTML tag related with this object. If none is found given the object type, null will be returned.
      • getClassName

        protected java.lang.String getClassName​(WebObjectInfo object)
        Return the class name to use for the generation of the HTML tag related with this object.
        Parameters:
        object - The WebObjectInfo for which the class name is required
        Returns:
        The Class name for that particular object this object. If none is found given the object type, null will be returned.
      • getFolderLinkClasses

        protected java.lang.String getFolderLinkClasses​(WebObjectInfo object)
        Return the className of the folderLink that is used to render the folder
        Parameters:
        object - The WebObjectInfo for which class name is requested.
        Returns:
        The class name
      • getObjectImageName

        protected java.lang.String getObjectImageName​(WebObjectInfo object)
        Utility method that helps giving the image name to use - based on the information available on the formal parameters - based on the the object type and/or subtype of the WebObjectInfo instance.
        Parameters:
        object - The WebObjectInfo for which it's image name is required.
        Returns:
        a String with the name of the image associated with the WebObjectInfo. If the type specified on the WebObjectInfo definition does not match the predefined list of styles, it looks then based on the subtype. If still not found, it will return a transparent image.
      • formatObjectInfoParameter

        protected java.lang.String formatObjectInfoParameter​(java.lang.String id,
                                                             java.lang.String type,
                                                             java.lang.String subType,
                                                             java.lang.String alias,
                                                             java.lang.String name)
        Outputs a string formatted the way the objectInfo argument of the event requires it
        Parameters:
        id - id of the object
        type - type of the object
        subType - subtype of the object (should be null if dealing with the filter event)
        alias - alias of the object
        name - name of the object
        Returns:
        a String with the following format: ID|Type|Subtype|Alias|Name or
      • isObjectTypeVisible

        protected boolean isObjectTypeVisible​(WebObjectInfo object)
        Is a validation method to check if the object's type is visible.
        Parameters:
        object - The WebObjectInfo whose type visibility has to be checked.
        Returns:
        True if the object key is found in the hash map of all the filtered types.
      • isObjectSubtypeVisible

        protected boolean isObjectSubtypeVisible​(WebObjectInfo object)
        Is a validation method to check if the object's type is visible.
        Parameters:
        object - The WebObjectInfo whose sub-type visibility has to be checked.
        Returns:
        True if the object key is found in the hash map of all the filtered sub-types.
      • generateTooltipInformation

        protected java.lang.String generateTooltipInformation​(java.lang.String objectAlias,
                                                              WebObjectInfo item)
        Generates a string that returns the information that would be displayed as a tooltip for the WebObjectInfo item.
        Parameters:
        objectAlias - a String that has an alias to be displayed on the tooltip along with the item's title.
        item - The WebObjectInfo for which the tooltip information has to be generated.
        Returns:
        a String with the object's tooltip information. This includes the Object Name, Alias and a description.
      • getObjectDescription

        protected java.lang.String getObjectDescription​(WebObjectInfo item)
        Returns the item's description from it's Object Info depending on whether the Allow HTML on object description property has been set.
        Parameters:
        item - The WebObjectInfo for which the description is required.
        Returns:
        a String with the description of the object.
      • shouldDisplayObject

        protected boolean shouldDisplayObject​(WebObjectInfo obj)
        Returns a boolean value if the user has enough ACLS and privileges to display the object.
        Parameters:
        The - WebObjectInfo for which the ACLs and privileges are checked.
        Returns:
        Whether the user has enough ACLs and privileges to display the object.
      • getTooltipTitle

        protected java.lang.String getTooltipTitle​(WebObjectInfo item)
        This method returns the tooltip title to be displayed on each object. It is generated based on the type of the object.
        Parameters:
        item - The WebObjectInfo based on which the tooltip has to be derived.
        Returns:
        A string with the appropriate tooltip.