Class %DeepSee.Model.property

class %DeepSee.Model.property extends %DeepSee.Model.node, %DeepSee.Model.source

Meta-data for a member property within a dimension level within a DeepSee cube.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	7	1

Summary

Properties
additionalDescription	description	disabled	displayName
factName	factSelectivity	formatString	hidden
isDescription	isModified	isName	isReference
linkClass	linkProperty	name	sort
sourceExpression	sourceProperty	useDisplayValue

Methods
%AddToSaveSet	%AtScaleConvertAggregate	%AtScaleConvertTimeFunction	%AtScaleConvertType
%AtScaleCreateMessageObj	%AtScaleExport	%AtScaleInitIndex	%AtScaleProcessSourceRef
%AtScaleProduceAttribute	%AtScaleProduceDataSet	%BindExport	%ClassIsLatestVersion
%ClassName	%ConstructClone	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%Extends	%GetParameter	%IsA
%IsModified	%New	%NormalizeObject	%ObjectModified
%OriginalNamespace	%PackageName	%QuoteList	%QuoteValue
%QuoteValueL10N	%RemoveFromSaveSet	%SerializeObject	%SetModified
%ValidateObject	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType

Properties

• property formatString as %DeepSee.Datatype.string(MAXLEN=100,XMLPROJECTION="attribute");

Optional format string to apply to this property.

• property hidden as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];

If true, this property is hidden. That is, it will not be listed among the level's properties within the various DeepSee utilities.
It can still be used within MDX queries and expressions.

• property isDescription as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];

Optional. If true, then this property is used to supply an alternate descriptive name for members of this level.
Only one property for a given level can set this property.

• property isName as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];

If true, then this property is used to supply the display name for members of this level.
Only one property for a given level can set this property.

• property isReference as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];

If true, then the value of this property is not stored within a dimension table. Instead its value is retrieved from the data source when a query is executed.

• property sort as %DeepSee.Datatype.string(VALUELIST=",asc,desc,asc numeric,desc numeric",XMLPROJECTION="attribute");

If specified, then use this property to sort members of the current level.
The value can be "asc" for ascending order, "desc" for descending order, "asc numeric" for ascending numeric order, or "desc numeric" for descending numeric order.
If more than one property specifies sorting, then members are sorted using a combination of properties. The sorting is applied in the order in which the properties are listed in the level definition.

• property useDisplayValue as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];

If true, then use the display (external) value of the field (if applicable) in the source table when fetching data for this property.
This is only applied for properties that specify a sourceProperty.

Methods

• method %AtScaleExport(pStatus As %Status = $$$OK, ByRef pAuxiliaryIndex As %DynamicAbstractObject = $$$NULLOREF) as %DynamicAbstractObject

Produce the structures needed to emit the appropriate JSON and export this item to AtScale


[USER] > [%DeepSee] > [Model] > [property]		Private Storage