Meta-data object that represents a measure within a DeepSee cube. More...

Inheritance diagram for measure:

[legend]

Collaboration diagram for measure:

[legend]

Public Attributes
	aggregate
	Default aggregate function applied to this measure. More...

	cube
	Cube that this measure belongs to. More...

	factNumber
	Define a stable fact number for this measure. More...

	formatString
	Optional format string to apply to this member. More...

	hidden
	If true, this measure is hidden. More...

	iKnowDictionaries
	If this is an "iKnow" measure, use this property to identify which Term Lists should. More...

	iKnowDomain
	If this is an "iKnow" measure and iKnowSource="domain", this attribute indicates. More...

	iKnowParameters
	If this is an "iKnow" measure, this property can be used to supply additional domain. More...

	iKnowSource
	If this is an "iKnow" measure, then this indicates the type of the source text for this. More...

	listingFilterOperator
	More...

	listingFilterValue
	More...

	scale
	The scale value (number of digits following the decimal point) used. More...

	searchable
	If true, this measure can be used to filter results. More...

	type
	This indicates the type of this measure. More...

	units
	Optional. More...

Public Attributes inherited from node
	additionalDescription
	More...

	description
	Optional description for this node. More...

	disabled
	Disabled flag. More...

	displayName
	Localized name of this element. More...

	isModified
	Client marker to track whether or not changes have been made too this item in the current session. More...

	name
	Logical name of this element. More...

Public Attributes inherited from source
	factName
	Optional. More...

	factSelectivity
	Optional. More...

	linkClass
	Optional. More...

	linkProperty
	Optional. More...

	sourceExpression
	Optional expression used to get the value of this member. More...

	sourceProperty
	Name of the property in the source data that provides the. More...

Private Member Functions
_.Library.DynamicAbstractObject	AtScaleExport (_.Library.Status pStatus, _.Library.DynamicAbstractObject pAuxiliaryIndex)
	Produce the structures needed to emit the appropriate JSON and export this item to AtScale.

_.Library.Status	Validate ()
	Test if this measure's definition is valid. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Static Public Attributes inherited from abstractNode
	XMLINCLUDEINGROUP = None
	Do not include this class in the XML groupings.

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

Meta-data object that represents a measure within a DeepSee cube.

At query processing time, a measure is treated as if it were a member of a special dimension called "Measures".

Member Function Documentation

◆ Validate()

_.Library.Status Validate ( )

private

Test if this measure's definition is valid.

As a side-effect, set the aggregate function if not specified.

Member Data Documentation

◆ aggregate

aggregate

Default aggregate function applied to this measure.

If not specified, the default aggregate for numeric measures is SUM and COUNT for all other types.

◆ cube

cube

Cube that this measure belongs to.

◆ factNumber

factNumber

Define a stable fact number for this measure.

◆ formatString

formatString

Optional format string to apply to this member.

◆ hidden

hidden

If true, this measure is hidden.

That is, it will not be listed among the

cube's members within the various DeepSee utilities.
It can still be used within MDX queries and expressions.

◆ iKnowDictionaries

iKnowDictionaries

If this is an "iKnow" measure, use this property to identify which Term Lists should.

be loaded as dictionaries for iKnow to match the iKnow measures text contents against. This attribute should contain a comma-separated list of existing Term List names. NOTE: this attribute cannot be used for iKnow-managed domains

◆ iKnowDomain

iKnowDomain

If this is an "iKnow" measure and iKnowSource="domain", this attribute indicates.

which domain the text corresponding to this fact is stored in.

◆ iKnowParameters

iKnowParameters

If this is an "iKnow" measure, this property can be used to supply additional domain.

parameters for the corresponding iKnow domain. This should be a semicolon-delimited list of double-colon-delimited parameter-name / parameter-value pairs. For example: "DefaultConfig::Spanish;Mat:DefaultProfile::-1" will force this domain to use the Configuration named "Spanish" and default Matching Profile -1. NOTE: this attribute cannot be used for iKnow-managed domains

◆ iKnowSource

iKnowSource

If this is an "iKnow" measure, then this indicates the type of the source text for this.

measure:
"string" – source is a string property or expression,
"stream" – source is a character stream property,
"file" – source is a string containing a file name.
"domain" – source is a string containing the external ID of a text already indexed in a domain identified by the iKnowDomain attribute.
For other measure types, this attribute is ignored.

◆ listingFilterOperator

listingFilterOperator

◆ listingFilterValue

listingFilterValue

◆ scale

scale

The scale value (number of digits following the decimal point) used.

for numeric measures. If not specified, then the scale of the source property is used, if possible.

◆ searchable

searchable

If true, this measure can be used to filter results.

Setting this true may result in additional indices being defined for this measure.

◆ type

type

This indicates the type of this measure.

The type specifies how this measure is used within MDX processing. The type can be one of the following:

"integer" - the measure contains an integer value that can be aggregated within an MDX query. If no aggregate is specified, then SUM is used.
"number" - the measure contains a numeric value that can be aggregated within an MDX query. If no aggregate is specified, then SUM is used.
"boolean" - the measure contains a boolean value that can be aggregated within an MDX query. If no aggregate is specified, then COUNT is used (which is equivalent to SUM).
"date" - the measure contains a date value (in +$H format). The only aggregates that can be used with a date measure are MIN, MAX, and AVG. If no aggregate is specified, then MAX is used.
"age" - the measure contains an age value (in days). The only aggregates that can be used with an age measure are MIN, MAX, and AVG. If no aggregate is specified, then AVG is used.
"string" - the measure contains a string value. The only aggregate that can be used with a string measure is COUNT. A string measure can be used as a way to add arbitrary data to a cube's fact table. String measures are not indexed.
"text" - similar to a "string" measure, except that it is indexed using a text index.
"iKnow" - a text value that is processed and indexed using the iKnow Smart Indexing API.

If not specified then the type will match the source property, as best as possible or be set to "number".

◆ units

units

Optional.

Units applied to this measure.

This is not currently used.

Public Attributes

Private Member Functions

Additional Inherited Members