Package org.openl.rules.table.properties

Interface ITableProperties

  • All Known Implementing Classes:
    TableProperties
    public interface ITableProperties

    • Method Detail

      • getAllProperties

        Map<String,​Object> getAllProperties()
        Map of properties that includes all properties for current table. It includes: - all properties physically defined in table with system ones; - inherited properties from category and module scopes; - properties set by default;
        Returns:
        Map of all properties relevant to current table.

      • getTableProperties

        Map<String,​Object> getTableProperties()
        Gets the Map of properties with name as key and value as value, this map contains all properties defined in source table. No inherited and no default properties.
        Returns:
        Map of properties defined in table.

      • getAllDimensionalProperties

        Map<String,​Object> getAllDimensionalProperties()
        Gets the Map of properties with name as key and value as value, this map contains all dimensional properties defined for table. To find out which property is dimensional see property definitions TablePropertyDefinitionUtils.getSystemProperties().
        Returns:
        Map of properties defined in table excluding system properties.

      • getCategoryProperties

        Map<String,​Object> getCategoryProperties()
        Map of properties applied to the category this table belongs to.
        Returns:
        Map of properties applied to the category this table belongs to.

      • getModuleProperties

        Map<String,​Object> getModuleProperties()
        Map of properties applied to the module this table belongs to.
        Returns:
        Map of properties applied to the module this table belongs to.

      • getGlobalProperties

        Map<String,​Object> getGlobalProperties()
        Map of properties applied globally and inheritable in modules.
        Returns:
        Map of properties applied to the module this table belongs to.

      • getDefaultProperties

        Map<String,​Object> getDefaultProperties()
        Map of properties that must be set by default. Default properties are set to the table when there is no such property defined on TABLE, CATEGORY and MODULE levels. To find out which property is default see property definitions TablePropertyDefinitionUtils.getSystemProperties().
        Returns:
        Map of properties that must be set by default.

      • getPropertyValue

        Object getPropertyValue​(String propertyName)
        Gets the value of the property by its name.
        Parameters:
        propertyName - Property name.
        Returns:
        Property value.

      • getPropertyValueAsString

        String getPropertyValueAsString​(String propertyName)
        Returns the value of the property as String. If the current property value is of Date type, gets the format of date from DefaultPropertyDefinitions.
        Parameters:
        propertyName - Name of the property.
        Returns:
        Value formatted to string. Null when there is no property with such name.

      • getPropertiesSection

        ILogicalTable getPropertiesSection()
        Gets the logical table of the properties defined in table.

      • setPropertiesSection

        void setPropertiesSection​(ILogicalTable propertySection)

      • getModulePropertiesTableSyntaxNode

        TableSyntaxNode getModulePropertiesTableSyntaxNode()

      • getGlobalPropertiesTableSyntaxNode

        TableSyntaxNode getGlobalPropertiesTableSyntaxNode()

      • setModulePropertiesTableSyntaxNode

        void setModulePropertiesTableSyntaxNode​(TableSyntaxNode modulePropertiesTableSyntaxNode)

      • setGlobalPropertiesTableSyntaxNode

        void setGlobalPropertiesTableSyntaxNode​(TableSyntaxNode globalPropertiesTableSyntaxNode)

      • getCategoryPropertiesTableSyntaxNode

        TableSyntaxNode getCategoryPropertiesTableSyntaxNode()

      • setCategoryPropertiesTableSyntaxNode

        void setCategoryPropertiesTableSyntaxNode​(TableSyntaxNode categoryPropertiesTableSyntaxNode)

      • getPropertyLevelDefinedOn

        InheritanceLevel getPropertyLevelDefinedOn​(String propertyName)
        Goes through the hierarchy of properties from TABLE to CATEGORY and then to MODULE and returns the level on which property is inherited or defined.
        Parameters:
        propertyName - Name of the property.
        Returns:
        level on which property is defined. NULL when there is no such property on all these levels. Or it can be set by default. So check is it applied as default. @see isPropertyAppliedByDefault(String)

      • isPropertyAppliedByDefault

        boolean isPropertyAppliedByDefault​(String propertyName)
        Check if the property with given name is applied for current table by default.
        Parameters:
        propertyName - name of the property.
        Returns:
        TRUE if the property with given name is applied for current table by default.

      • isPropertiesEmpty

        boolean isPropertiesEmpty()
        Checks that current table does not have properties.
        Returns:

      • setName

        void setName​(String name)

      • getCategory

        String getCategory()

      • setCategory

        void setCategory​(String category)

      • getCreatedBy

        String getCreatedBy()

      • setCreatedBy

        void setCreatedBy​(String createdBy)

      • getCreatedOn

        Date getCreatedOn()

      • setCreatedOn

        void setCreatedOn​(Date createdOn)

      • getModifiedBy

        String getModifiedBy()

      • setModifiedBy

        void setModifiedBy​(String modifiedBy)

      • getModifiedOn

        Date getModifiedOn()

      • setModifiedOn

        void setModifiedOn​(Date modifiedOn)

      • getDescription

        String getDescription()

      • setDescription

        void setDescription​(String description)

      • setTags

        void setTags​(String... tags)

      • getEffectiveDate

        Date getEffectiveDate()

      • setEffectiveDate

        void setEffectiveDate​(Date effectiveDate)

      • getExpirationDate

        Date getExpirationDate()

      • setExpirationDate

        void setExpirationDate​(Date expirationDate)

      • getStartRequestDate

        Date getStartRequestDate()

      • setStartRequestDate

        void setStartRequestDate​(Date startRequestDate)

      • getEndRequestDate

        Date getEndRequestDate()

      • setEndRequestDate

        void setEndRequestDate​(Date endRequestDate)

      • setCaRegions

        void setCaRegions​(CaRegionsEnum... caRegions)

      • setLob

        void setLob​(String... lob)

      • getVersion

        String getVersion()

      • setVersion

        void setVersion​(String version)

      • setActive

        void setActive​(Boolean active)

      • setId

        void setId​(String id)

      • getBuildPhase

        String getBuildPhase()

      • setBuildPhase

        void setBuildPhase​(String buildPhase)

      • getFailOnMiss

        Boolean getFailOnMiss()

      • setFailOnMiss

        void setFailOnMiss​(Boolean failOnMiss)

      • setScope

        void setScope​(String scope)

      • getPriority

        Integer getPriority()

      • setPriority

        void setPriority​(Integer priority)

      • getDatatypePackage

        String getDatatypePackage()

      • setDatatypePackage

        void setDatatypePackage​(String datatypePackage)

      • getSpreadsheetResultPackage

        String getSpreadsheetResultPackage()

      • setSpreadsheetResultPackage

        void setSpreadsheetResultPackage​(String spreadsheetResultPackage)

      • getCacheable

        Boolean getCacheable()

      • setCacheable

        void setCacheable​(Boolean cacheable)

      • getPrecision

        String getPrecision()

      • setPrecision

        void setPrecision​(String precision)

      • getTableStructureDetails

        Boolean getTableStructureDetails()

      • setTableStructureDetails

        void setTableStructureDetails​(Boolean tableStructureDetails)

      • getAutoType

        Boolean getAutoType()

      • setAutoType

        void setAutoType​(Boolean autoType)

      • getCalculateAllCells

        Boolean getCalculateAllCells()

      • setCalculateAllCells

        void setCalculateAllCells​(Boolean calculateAllCells)

      • getParallel

        Boolean getParallel()

      • setParallel

        void setParallel​(Boolean parallel)

      • getNature

        String getNature()

      • setNature

        void setNature​(String nature)

      • setCategoryProperties

        void setCategoryProperties​(Map<String,​Object> categoryProperties)

      • setModuleProperties

        void setModuleProperties​(Map<String,​Object> moduleProperties)

      • setGlobalProperties

        void setGlobalProperties​(Map<String,​Object> moduleProperties)

      • setExternalProperties

        void setExternalProperties​(Map<String,​Object> moduleProperties)

      • setDefaultProperties

        void setDefaultProperties​(Map<String,​Object> defaultProperties)

      • setCurrentTableType

        void setCurrentTableType​(String currentTableType)

      • getCurrentTableType

        String getCurrentTableType()