TableProperties (OpenL - DEV - Engine 5.22.6 API)

java.lang.Object
- org.openl.types.impl.DynamicObject
- - org.openl.rules.table.properties.TableProperties

All Implemented Interfaces:: ITableProperties, IDynamicObject

public class TableProperties
extends DynamicObject
implements ITableProperties

Constructor Summary

Constructors
Constructor and Description

TableProperties()

Constructors
Constructor and Description
`TableProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getActive()`
`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.
`Map<String,Object>`	`getAllProperties()` `Map` of properties that includes all properties for current table.
`Boolean`	`getAutoType()`
`String`	`getBuildPhase()`
`Boolean`	`getCacheable()`
`Boolean`	`getCalculateAllCells()`
`CaProvincesEnum[]`	`getCaProvinces()`
`CaRegionsEnum[]`	`getCaRegions()`
`String`	`getCategory()`
`Map<String,Object>`	`getCategoryProperties()` `Map` of properties applied to the category this table belongs to.
`TableSyntaxNode`	`getCategoryPropertiesTableSyntaxNode()`
`CountriesEnum[]`	`getCountry()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`CurrenciesEnum[]`	`getCurrency()`
`String`	`getCurrentTableType()`
`String`	`getDatatypePackage()`
`Map<String,Object>`	`getDefaultProperties()` `Map` of properties that must be set by default.
`String`	`getDescription()`
`Date`	`getEffectiveDate()`
`Date`	`getEndRequestDate()`
`Date`	`getExpirationDate()`
`Map<String,Object>`	`getExternalProperties()`
`Boolean`	`getFailOnMiss()`
`String`	`getId()`
`TableSyntaxNode`	`getInheritedPropertiesTableSyntaxNode(InheritanceLevel inheritanceLevel)`
`LanguagesEnum[]`	`getLang()`
`String[]`	`getLob()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`Map<String,Object>`	`getModuleProperties()` `Map` of properties applied to the module this table belongs to.
`TableSyntaxNode`	`getModulePropertiesTableSyntaxNode()`
`String`	`getName()`
`String`	`getNature()`
`OriginsEnum`	`getOrigin()`
`Boolean`	`getParallel()`
`String`	`getPrecision()`
`ILogicalTable`	`getPropertiesSection()` Gets the logical table of the properties defined in table.
`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.
`Object`	`getPropertyValue(String key)` Gets the value of the property by its name.
`String`	`getPropertyValueAsString(String key)` Returns the value of the property as `String`.
`RecalculateEnum`	`getRecalculate()`
`RegionsEnum[]`	`getRegion()`
`String`	`getScope()`
`Date`	`getStartRequestDate()`
`UsStatesEnum[]`	`getState()`
`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.
`String[]`	`getTags()`
`IOpenClass`	`getType()`
`UsRegionsEnum[]`	`getUsregion()`
`ValidateDTEnum`	`getValidateDT()`
`String`	`getVersion()`
`boolean`	`isPropertiesEmpty()` Checks that current table doesn't have properties.
`boolean`	`isPropertyAppliedByDefault(String propertyName)` Check if the property with given name is applied for current table by default.
`void`	`setActive(Boolean active)`
`void`	`setAutoType(Boolean autoType)`
`void`	`setBuildPhase(String buildPhase)`
`void`	`setCacheable(Boolean cacheable)`
`void`	`setCalculateAllCells(Boolean calculateAllCells)`
`void`	`setCaProvinces(CaProvincesEnum... caProvinces)`
`void`	`setCaRegions(CaRegionsEnum... caRegions)`
`void`	`setCategory(String category)`
`void`	`setCategoryProperties(Map<String,Object> categoryProperties)`
`void`	`setCategoryPropertiesTableSyntaxNode(TableSyntaxNode categoryPropertiesTableSyntaxNode)`
`void`	`setCountry(CountriesEnum... country)`
`void`	`setCreatedBy(String createdBy)`
`void`	`setCreatedOn(Date createdOn)`
`void`	`setCurrency(CurrenciesEnum... currency)`
`void`	`setCurrentTableType(String currentTableType)`
`void`	`setDatatypePackage(String datatypePackage)`
`void`	`setDefaultProperties(Map<String,Object> defaultProperties)`
`void`	`setDescription(String description)`
`void`	`setEffectiveDate(Date effectiveDate)`
`void`	`setEndRequestDate(Date endRequestDate)`
`void`	`setExpirationDate(Date expirationDate)`
`void`	`setExternalProperties(Map<String,Object> externalProperties)`
`void`	`setFailOnMiss(Boolean failOnMiss)`
`void`	`setFieldValue(String name, Object value)`
`void`	`setId(String id)`
`void`	`setLang(LanguagesEnum... lang)`
`void`	`setLob(String... lob)`
`void`	`setModifiedBy(String modifiedBy)`
`void`	`setModifiedOn(Date modifiedOn)`
`void`	`setModuleProperties(Map<String,Object> moduleProperties)`
`void`	`setModulePropertiesTableSyntaxNode(TableSyntaxNode modulePropertiesTableSyntaxNode)`
`void`	`setName(String name)`
`void`	`setNature(String nature)`
`void`	`setOrigin(OriginsEnum origin)`
`void`	`setParallel(Boolean parallel)`
`void`	`setPrecision(String precision)`
`void`	`setPropertiesSection(ILogicalTable propertySection)`
`void`	`setRecalculate(RecalculateEnum recalculate)`
`void`	`setRegion(RegionsEnum... region)`
`void`	`setScope(String scope)`
`void`	`setStartRequestDate(Date startRequestDate)`
`void`	`setState(UsStatesEnum... state)`
`void`	`setTags(String... tags)`
`void`	`setType(IOpenClass type)`
`void`	`setUsregion(UsRegionsEnum... usregion)`
`void`	`setValidateDT(ValidateDTEnum validateDT)`
`void`	`setVersion(String version)`

Methods inherited from class org.openl.types.impl.DynamicObject
containsField, getFieldValue, getFieldValues, getNicePrinterAdaptor, isMyField, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TableProperties
```
public TableProperties()
```
- Method Detail
  - getType
```
public IOpenClass getType()
```
    Specified by:
    
    getType in interface IDynamicObject
    
    Overrides:
    
    getType in class DynamicObject
  - setType
```
public void setType(IOpenClass type)
```
    Overrides:
    
    setType in class DynamicObject
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface ITableProperties
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface ITableProperties
  - getCategory
```
public String getCategory()
```
    Specified by:
    
    getCategory in interface ITableProperties
  - setCategory
```
public void setCategory(String category)
```
    Specified by:
    
    setCategory in interface ITableProperties
  - getCreatedBy
```
public String getCreatedBy()
```
    Specified by:
    
    getCreatedBy in interface ITableProperties
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    Specified by:
    
    setCreatedBy in interface ITableProperties
  - getCreatedOn
```
public Date getCreatedOn()
```
    Specified by:
    
    getCreatedOn in interface ITableProperties
  - setCreatedOn
```
public void setCreatedOn(Date createdOn)
```
    Specified by:
    
    setCreatedOn in interface ITableProperties
  - getModifiedBy
```
public String getModifiedBy()
```
    Specified by:
    
    getModifiedBy in interface ITableProperties
  - setModifiedBy
```
public void setModifiedBy(String modifiedBy)
```
    Specified by:
    
    setModifiedBy in interface ITableProperties
  - getModifiedOn
```
public Date getModifiedOn()
```
    Specified by:
    
    getModifiedOn in interface ITableProperties
  - setModifiedOn
```
public void setModifiedOn(Date modifiedOn)
```
    Specified by:
    
    setModifiedOn in interface ITableProperties
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface ITableProperties
  - setDescription
```
public void setDescription(String description)
```
    Specified by:
    
    setDescription in interface ITableProperties
  - getTags
```
public String[] getTags()
```
    Specified by:
    
    getTags in interface ITableProperties
  - setTags
```
public void setTags(String... tags)
```
    Specified by:
    
    setTags in interface ITableProperties
  - getEffectiveDate
```
public Date getEffectiveDate()
```
    Specified by:
    
    getEffectiveDate in interface ITableProperties
  - setEffectiveDate
```
public void setEffectiveDate(Date effectiveDate)
```
    Specified by:
    
    setEffectiveDate in interface ITableProperties
  - getExpirationDate
```
public Date getExpirationDate()
```
    Specified by:
    
    getExpirationDate in interface ITableProperties
  - setExpirationDate
```
public void setExpirationDate(Date expirationDate)
```
    Specified by:
    
    setExpirationDate in interface ITableProperties
  - getStartRequestDate
```
public Date getStartRequestDate()
```
    Specified by:
    
    getStartRequestDate in interface ITableProperties
  - setStartRequestDate
```
public void setStartRequestDate(Date startRequestDate)
```
    Specified by:
    
    setStartRequestDate in interface ITableProperties
  - getEndRequestDate
```
public Date getEndRequestDate()
```
    Specified by:
    
    getEndRequestDate in interface ITableProperties
  - setEndRequestDate
```
public void setEndRequestDate(Date endRequestDate)
```
    Specified by:
    
    setEndRequestDate in interface ITableProperties
  - getCaRegions
```
public CaRegionsEnum[] getCaRegions()
```
    Specified by:
    
    getCaRegions in interface ITableProperties
  - setCaRegions
```
public void setCaRegions(CaRegionsEnum... caRegions)
```
    Specified by:
    
    setCaRegions in interface ITableProperties
  - getCaProvinces
```
public CaProvincesEnum[] getCaProvinces()
```
    Specified by:
    
    getCaProvinces in interface ITableProperties
  - setCaProvinces
```
public void setCaProvinces(CaProvincesEnum... caProvinces)
```
    Specified by:
    
    setCaProvinces in interface ITableProperties
  - getCountry
```
public CountriesEnum[] getCountry()
```
    Specified by:
    
    getCountry in interface ITableProperties
  - setCountry
```
public void setCountry(CountriesEnum... country)
```
    Specified by:
    
    setCountry in interface ITableProperties
  - getRegion
```
public RegionsEnum[] getRegion()
```
    Specified by:
    
    getRegion in interface ITableProperties
  - setRegion
```
public void setRegion(RegionsEnum... region)
```
    Specified by:
    
    setRegion in interface ITableProperties
  - getCurrency
```
public CurrenciesEnum[] getCurrency()
```
    Specified by:
    
    getCurrency in interface ITableProperties
  - setCurrency
```
public void setCurrency(CurrenciesEnum... currency)
```
    Specified by:
    
    setCurrency in interface ITableProperties
  - getLang
```
public LanguagesEnum[] getLang()
```
    Specified by:
    
    getLang in interface ITableProperties
  - setLang
```
public void setLang(LanguagesEnum... lang)
```
    Specified by:
    
    setLang in interface ITableProperties
  - getLob
```
public String[] getLob()
```
    Specified by:
    
    getLob in interface ITableProperties
  - setLob
```
public void setLob(String... lob)
```
    Specified by:
    
    setLob in interface ITableProperties
  - getOrigin
```
public OriginsEnum getOrigin()
```
    Specified by:
    
    getOrigin in interface ITableProperties
  - setOrigin
```
public void setOrigin(OriginsEnum origin)
```
    Specified by:
    
    setOrigin in interface ITableProperties
  - getUsregion
```
public UsRegionsEnum[] getUsregion()
```
    Specified by:
    
    getUsregion in interface ITableProperties
  - setUsregion
```
public void setUsregion(UsRegionsEnum... usregion)
```
    Specified by:
    
    setUsregion in interface ITableProperties
  - getState
```
public UsStatesEnum[] getState()
```
    Specified by:
    
    getState in interface ITableProperties
  - setState
```
public void setState(UsStatesEnum... state)
```
    Specified by:
    
    setState in interface ITableProperties
  - getVersion
```
public String getVersion()
```
    Specified by:
    
    getVersion in interface ITableProperties
  - setVersion
```
public void setVersion(String version)
```
    Specified by:
    
    setVersion in interface ITableProperties
  - getActive
```
public Boolean getActive()
```
    Specified by:
    
    getActive in interface ITableProperties
  - setActive
```
public void setActive(Boolean active)
```
    Specified by:
    
    setActive in interface ITableProperties
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface ITableProperties
  - setId
```
public void setId(String id)
```
    Specified by:
    
    setId in interface ITableProperties
  - getBuildPhase
```
public String getBuildPhase()
```
    Specified by:
    
    getBuildPhase in interface ITableProperties
  - setBuildPhase
```
public void setBuildPhase(String buildPhase)
```
    Specified by:
    
    setBuildPhase in interface ITableProperties
  - getValidateDT
```
public ValidateDTEnum getValidateDT()
```
    Specified by:
    
    getValidateDT in interface ITableProperties
  - setValidateDT
```
public void setValidateDT(ValidateDTEnum validateDT)
```
    Specified by:
    
    setValidateDT in interface ITableProperties
  - getFailOnMiss
```
public Boolean getFailOnMiss()
```
    Specified by:
    
    getFailOnMiss in interface ITableProperties
  - setFailOnMiss
```
public void setFailOnMiss(Boolean failOnMiss)
```
    Specified by:
    
    setFailOnMiss in interface ITableProperties
  - getScope
```
public String getScope()
```
    Specified by:
    
    getScope in interface ITableProperties
  - setScope
```
public void setScope(String scope)
```
    Specified by:
    
    setScope in interface ITableProperties
  - getDatatypePackage
```
public String getDatatypePackage()
```
    Specified by:
    
    getDatatypePackage in interface ITableProperties
  - setDatatypePackage
```
public void setDatatypePackage(String datatypePackage)
```
    Specified by:
    
    setDatatypePackage in interface ITableProperties
  - getCacheable
```
public Boolean getCacheable()
```
    Specified by:
    
    getCacheable in interface ITableProperties
  - setCacheable
```
public void setCacheable(Boolean cacheable)
```
    Specified by:
    
    setCacheable in interface ITableProperties
  - getRecalculate
```
public RecalculateEnum getRecalculate()
```
    Specified by:
    
    getRecalculate in interface ITableProperties
  - setRecalculate
```
public void setRecalculate(RecalculateEnum recalculate)
```
    Specified by:
    
    setRecalculate in interface ITableProperties
  - getPrecision
```
public String getPrecision()
```
    Specified by:
    
    getPrecision in interface ITableProperties
  - setPrecision
```
public void setPrecision(String precision)
```
    Specified by:
    
    setPrecision in interface ITableProperties
  - getAutoType
```
public Boolean getAutoType()
```
    Specified by:
    
    getAutoType in interface ITableProperties
  - setAutoType
```
public void setAutoType(Boolean autoType)
```
    Specified by:
    
    setAutoType in interface ITableProperties
  - getCalculateAllCells
```
public Boolean getCalculateAllCells()
```
    Specified by:
    
    getCalculateAllCells in interface ITableProperties
  - setCalculateAllCells
```
public void setCalculateAllCells(Boolean calculateAllCells)
```
    Specified by:
    
    setCalculateAllCells in interface ITableProperties
  - getParallel
```
public Boolean getParallel()
```
    Specified by:
    
    getParallel in interface ITableProperties
  - setParallel
```
public void setParallel(Boolean parallel)
```
    Specified by:
    
    setParallel in interface ITableProperties
  - getNature
```
public String getNature()
```
    Specified by:
    
    getNature in interface ITableProperties
  - setNature
```
public void setNature(String nature)
```
    Specified by:
    
    setNature in interface ITableProperties
  - getPropertyValue
```
public Object getPropertyValue(String key)
```
    Gets the value of the property by its name.
    
    Specified by:
    
    getPropertyValue in interface ITableProperties
    
    Parameters:
    
    key - Property name.
    
    Returns:
    
    Property value.
  - getPropertyValueAsString
```
public String getPropertyValueAsString(String key)
```
    Returns the value of the property as String. If the current property value is of Date type, gets the format of date from DefaultPropertyDefinitions.
    
    Specified by:
    
    getPropertyValueAsString in interface ITableProperties
    
    Parameters:
    
    key - Name of the property.
    
    Returns:
    
    Value formatted to string. Null when there is no property with such name.
  - getPropertyLevelDefinedOn
```
public 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.
    
    Specified by:
    
    getPropertyLevelDefinedOn in interface ITableProperties
    
    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 {@link #isPropertyAppliedByDefault(String)
  - isPropertyAppliedByDefault
```
public boolean isPropertyAppliedByDefault(String propertyName)
```
    Check if the property with given name is applied for current table by default.
    
    Specified by:
    
    isPropertyAppliedByDefault in interface ITableProperties
    
    Parameters:
    
    propertyName - name of the property.
    
    Returns:
    
    TRUE if the property with given name is applied for current table by default.
  - getPropertiesSection
```
public ILogicalTable getPropertiesSection()
```
    Gets the logical table of the properties defined in table.
    
    Specified by:
    
    getPropertiesSection in interface ITableProperties
  - setPropertiesSection
```
public void setPropertiesSection(ILogicalTable propertySection)
```
    Specified by:
    
    setPropertiesSection in interface ITableProperties
  - getModulePropertiesTableSyntaxNode
```
public TableSyntaxNode getModulePropertiesTableSyntaxNode()
```
    Specified by:
    
    getModulePropertiesTableSyntaxNode in interface ITableProperties
  - setModulePropertiesTableSyntaxNode
```
public void setModulePropertiesTableSyntaxNode(TableSyntaxNode modulePropertiesTableSyntaxNode)
```
    Specified by:
    
    setModulePropertiesTableSyntaxNode in interface ITableProperties
  - getCategoryPropertiesTableSyntaxNode
```
public TableSyntaxNode getCategoryPropertiesTableSyntaxNode()
```
    Specified by:
    
    getCategoryPropertiesTableSyntaxNode in interface ITableProperties
  - setCategoryPropertiesTableSyntaxNode
```
public void setCategoryPropertiesTableSyntaxNode(TableSyntaxNode categoryPropertiesTableSyntaxNode)
```
    Specified by:
    
    setCategoryPropertiesTableSyntaxNode in interface ITableProperties
  - getInheritedPropertiesTableSyntaxNode
```
public TableSyntaxNode getInheritedPropertiesTableSyntaxNode(InheritanceLevel inheritanceLevel)
```
    Specified by:
    
    getInheritedPropertiesTableSyntaxNode in interface ITableProperties
  - getAllProperties
```
public 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;
    
    Specified by:
    
    getAllProperties in interface ITableProperties
    
    Returns:
    
    Map of all properties relevant to current table.
  - setFieldValue
```
public void setFieldValue(String name,
                          Object value)
```
    Specified by:
    
    setFieldValue in interface IDynamicObject
    
    Overrides:
    
    setFieldValue in class DynamicObject
  - getTableProperties
```
public 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.
    
    Specified by:
    
    getTableProperties in interface ITableProperties
    
    Returns:
    
    Map of properties defined in table.
  - getAllDimensionalProperties
```
public 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().
    
    Specified by:
    
    getAllDimensionalProperties in interface ITableProperties
    
    Returns:
    
    Map of properties defined in table excluding system properties.
  - setCategoryProperties
```
public void setCategoryProperties(Map<String,Object> categoryProperties)
```
    Specified by:
    
    setCategoryProperties in interface ITableProperties
  - getCategoryProperties
```
public Map<String,Object> getCategoryProperties()
```
    Map of properties applied to the category this table belongs to.
    
    Specified by:
    
    getCategoryProperties in interface ITableProperties
    
    Returns:
    
    Map of properties applied to the category this table belongs to.
  - setModuleProperties
```
public void setModuleProperties(Map<String,Object> moduleProperties)
```
    Specified by:
    
    setModuleProperties in interface ITableProperties
  - getModuleProperties
```
public Map<String,Object> getModuleProperties()
```
    Map of properties applied to the module this table belongs to.
    
    Specified by:
    
    getModuleProperties in interface ITableProperties
    
    Returns:
    
    Map of properties applied to the module this table belongs to.
  - setDefaultProperties
```
public void setDefaultProperties(Map<String,Object> defaultProperties)
```
    Specified by:
    
    setDefaultProperties in interface ITableProperties
  - getDefaultProperties
```
public 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().
    
    Specified by:
    
    getDefaultProperties in interface ITableProperties
    
    Returns:
    
    Map of properties that must be set by default.
  - setCurrentTableType
```
public void setCurrentTableType(String currentTableType)
```
    Specified by:
    
    setCurrentTableType in interface ITableProperties
  - getCurrentTableType
```
public String getCurrentTableType()
```
    Specified by:
    
    getCurrentTableType in interface ITableProperties
  - getExternalProperties
```
public Map<String,Object> getExternalProperties()
```
    Specified by:
    
    getExternalProperties in interface ITableProperties
  - setExternalProperties
```
public void setExternalProperties(Map<String,Object> externalProperties)
```
    Specified by:
    
    setExternalProperties in interface ITableProperties
  - isPropertiesEmpty
```
public boolean isPropertiesEmpty()
```
    Checks that current table doesn't have properties.
    
    Specified by:
    
    isPropertiesEmpty in interface ITableProperties
    
    Returns:

Class TableProperties

Constructor Summary

Method Summary

Methods inherited from class org.openl.types.impl.DynamicObject

Methods inherited from class java.lang.Object

Constructor Detail

TableProperties

Method Detail

getType

setType

getName

setName

getCategory

setCategory

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy

setModifiedBy

getModifiedOn

setModifiedOn

getDescription

setDescription

getTags

setTags

getEffectiveDate

setEffectiveDate

getExpirationDate

setExpirationDate

getStartRequestDate

setStartRequestDate

getEndRequestDate

setEndRequestDate

getCaRegions

setCaRegions

getCaProvinces

setCaProvinces

getCountry

setCountry

getRegion

setRegion

getCurrency

setCurrency

getLang

setLang

getLob

setLob

getOrigin

setOrigin

getUsregion

setUsregion

getState

setState

getVersion

setVersion

getActive

setActive

getId

setId

getBuildPhase

setBuildPhase

getValidateDT

setValidateDT

getFailOnMiss

setFailOnMiss

getScope

setScope

getDatatypePackage

setDatatypePackage

getCacheable

setCacheable

getRecalculate

setRecalculate

getPrecision

setPrecision

getAutoType

setAutoType

getCalculateAllCells

setCalculateAllCells