Packageorg.omoa.framework
Classpublic class Description
InheritanceDescription Inheritance Object

A Description stores a description of a value within a DataModel or a subset of a DataModel; example of a Description: "GERMANY.FEMALE.1989.GDP".



Public Properties
 PropertyDefined By
  hasValueIndex : Boolean
Description
  model : IDataModel
[read-only]
Description
  representsScalar : Boolean
[read-only]
Description
  representsSomething : Boolean
[read-only]
Description
  valueIndex : int
Description
Public Methods
 MethodDefined By
  
Description(model:IDataModel, propertyDimensions:Vector.<ModelDimension>, valueDimensions:Vector.<ModelDimension>, descriptionString:String = null)
Description
  
combine(target:Description, gapFiller:Description):void
Description
  
fromString(descriptionString:String):void
Description
  
selectByCode(order:int, code:String):Boolean
Description
  
selectByIndex(order:int, codeIndex:int):void
Description
  
selectedCode(order:int):String
Description
  
Description
  
Description
  
selectedIndex(order:int):int
Description
  
toString():String
Description
  
Description
Public Constants
 ConstantDefined By
  SEPARATOR : String = .
[static]
Description
  UNDEFINED : String = _
[static]
Description
  UNDEFINED_INDEX : int = 0
[static]
Description
  WILDCARD : String = *
[static]
Description
  WILDCARD_INDEX : int = -1
[static]
Description
Property Detail
hasValueIndexproperty
public var hasValueIndex:Boolean

modelproperty 
model:IDataModel  [read-only]


Implementation
    public function get model():IDataModel
representsScalarproperty 
representsScalar:Boolean  [read-only]


Implementation
    public function get representsScalar():Boolean
representsSomethingproperty 
representsSomething:Boolean  [read-only]


Implementation
    public function get representsSomething():Boolean
valueIndexproperty 
public var valueIndex:int

Constructor Detail
Description()Constructor
public function Description(model:IDataModel, propertyDimensions:Vector.<ModelDimension>, valueDimensions:Vector.<ModelDimension>, descriptionString:String = null)



Parameters
model:IDataModel
 
propertyDimensions:Vector.<ModelDimension>
 
valueDimensions:Vector.<ModelDimension>
 
descriptionString:String (default = null)
Method Detail
combine()method
public function combine(target:Description, gapFiller:Description):void

Parameters

target:Description
 
gapFiller:Description

fromString()method 
public function fromString(descriptionString:String):void

Parameters

descriptionString:String

selectByCode()method 
public function selectByCode(order:int, code:String):Boolean

Parameters

order:int
 
code:String (default = NaN)

Returns
Boolean
selectByIndex()method 
public function selectByIndex(order:int, codeIndex:int):void

Parameters

order:int
 
codeIndex:int (default = NaN)

selectedCode()method 
public function selectedCode(order:int):String

Parameters

order:int

Returns
String
selectedDimension()method 
public function selectedDimension(order:int):ModelDimension

Parameters

order:int

Returns
ModelDimension
selectedDimensionCount()method 
public function selectedDimensionCount():int

Returns
int
selectedIndex()method 
public function selectedIndex(order:int):int

Parameters

order:int

Returns
int
toString()method 
public function toString():String

Returns
String
valueDimensionOrder()method 
public function valueDimensionOrder():int

Returns
int
Constant Detail
SEPARATORConstant
public static const SEPARATOR:String = .

UNDEFINEDConstant 
public static const UNDEFINED:String = _

UNDEFINED_INDEXConstant 
public static const UNDEFINED_INDEX:int = 0

WILDCARDConstant 
public static const WILDCARD:String = *

WILDCARD_INDEXConstant 
public static const WILDCARD_INDEX:int = -1