property Class Reference

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

Inheritance diagram for property:

Collaboration diagram for property:

Public Attributes
	formatString
	Optional format string to apply to this property. More...
	hidden
	If true, this property is hidden. More...
	isDescription
	Optional. More...
	isName
	If true, then this property is used to supply the display name for members. More...
	isReference
	If true, then the value of this property is not stored within a dimension. More...
	sort
	If specified, then use this property to sort members of the current level. More...
	useDisplayValue
	If true, then use the display (external) value of the field (if applicable) in the source. 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.

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 for a member property within a dimension level within a DeepSee cube.

Member Data Documentation

formatString

formatString

Optional format string to apply to this property.

 

hidden

hidden

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.  

isDescription

isDescription

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.  

isName

isName

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.  

isReference

isReference

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.  

sort

sort

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.  

useDisplayValue

useDisplayValue

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 <property>sourceProperty</property>.