DRAttribute (Project Wonder Reference Documentation)

java.lang.Object
- er.grouping.DRAttribute

Direct Known Subclasses:

DRAttributeGroup
```
public class DRAttribute
extends Object
```
DRAttributes are to display what EOAttributes are to the back-end. Each DRAttribute can be defined with:
- 'keyPath' (what you want to ask the dictionary or EO)
- 'label' (what you want to call the attribute for display)
- a boolean for 'shouldTotal'
- a boolean for 'shouldSort'
- 'format' for formatting dates
- a toggle turning a attribute into a group.
Each group can have 0 or more DRAttributes within it.
Author:

david neumann

Field Summary

Fields
Modifier and Type	Field and Description
`protected DRAttributeGroup`	`_attributeGroup`
`protected NSArray`	`_emptyArray`
`protected String`	`_format`
`protected boolean`	`_isComputed`
`protected boolean`	`_isGroup`
`protected boolean`	`_isPlaceHolderTotal`
`protected boolean`	`_isTotal`
`protected String`	`_keyPath`
`protected String`	`_label`
`protected boolean`	`_shouldRestrictToFirstRow`
`protected boolean`	`_shouldSort`
`protected boolean`	`_shouldTotal`
`protected NSDictionary`	`_userInfo`

Constructor Summary

Constructors
Constructor and Description
`DRAttribute()`
`DRAttribute(DRAttributeGroup attributeGroup)` Constructor with DRAttributeGroup.
`DRAttribute(String keyPath, String format, String label, boolean shouldTotal, NSDictionary userInfo)` Constructor with parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DRAttributeGroup`	`attributeGroup()`
`NSMutableArray`	`attributes()`
`double`	`computeFromRawRecords(NSArray rawRecords)`
`NSArray`	`flatAttributes()`
`NSArray`	`flatAttributesTotal()`
`protected NSArray`	`flatAttributesWithDepthDictionary(int attributeListDepth, NSMutableDictionary flatAttributeDepthDict)`
`String`	`format()`
`boolean`	`isComputed()`
`boolean`	`isGroup()`
`boolean`	`isPlaceHolderTotal()`
`String`	`keyPath()`
`String`	`label()`
`void`	`resetDefaults()`
`void`	`setAttributeGroup(DRAttributeGroup attributeGroup)`
`void`	`setFormat(String value)`
`void`	`setIsPlaceHolderTotal(boolean value)`
`void`	`setKeyPath(String value)`
`void`	`setLabel(String value)`
`void`	`setShouldRestrictToFirstRow(boolean value)`
`void`	`setShouldSort(boolean value)`
`void`	`setShouldTotal(boolean value)`
`void`	`setUserInfo(NSDictionary value)`
`boolean`	`shouldRestrictToFirstRow()`
`boolean`	`shouldSort()`
`boolean`	`shouldTotal()`
`boolean`	`showTotal()`
`String`	`toString()`
`NSDictionary`	`userInfo()`
`static DRAttribute`	`withAttributeGroup(DRAttributeGroup attributeGroup)` Creates a new DRAttributes from a DRAttributeGroup.
`static DRAttribute`	`withKeyPathFormatLabelTotalUserInfo(String keyPath, String format, String label, boolean shouldTotal, NSDictionary userInfo)` Creates a new DRAttribute from the supplied parmeters.

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

Field Detail

_keyPath
```
protected String _keyPath
```

_format
```
protected String _format
```

_shouldTotal
```
protected boolean _shouldTotal
```

_shouldSort
```
protected boolean _shouldSort
```

_shouldRestrictToFirstRow

protected boolean _shouldRestrictToFirstRow

_isGroup
```
protected boolean _isGroup
```

_label
```
protected String _label
```

_userInfo
```
protected NSDictionary _userInfo
```

_attributeGroup

protected DRAttributeGroup _attributeGroup

_isPlaceHolderTotal
```
protected boolean _isPlaceHolderTotal
```

_isTotal
```
protected boolean _isTotal
```

_isComputed
```
protected boolean _isComputed
```

_emptyArray
```
protected NSArray _emptyArray
```

Constructor Detail

DRAttribute

public DRAttribute(String keyPath,
                   String format,
                   String label,
                   boolean shouldTotal,
                   NSDictionary userInfo)

Constructor with parameters.

Parameters:: keyPath -; format -; label -; shouldTotal -; userInfo -

DRAttribute
```
public DRAttribute(DRAttributeGroup attributeGroup)
```
Constructor with DRAttributeGroup.

Parameters:

attributeGroup -

DRAttribute
```
public DRAttribute()
```

Method Detail

withAttributeGroup
```
public static DRAttribute withAttributeGroup(DRAttributeGroup attributeGroup)
```
Creates a new DRAttributes from a DRAttributeGroup.

Parameters:

attributeGroup -

withKeyPathFormatLabelTotalUserInfo

public static DRAttribute withKeyPathFormatLabelTotalUserInfo(String keyPath,
                                                              String format,
                                                              String label,
                                                              boolean shouldTotal,
                                                              NSDictionary userInfo)

Creates a new DRAttribute from the supplied parmeters.

Parameters:: keyPath -; format -; label -; shouldTotal -; userInfo -

resetDefaults
```
public void resetDefaults()
```

keyPath
```
public String keyPath()
```

setKeyPath
```
public void setKeyPath(String value)
```

format
```
public String format()
```

setFormat
```
public void setFormat(String value)
```

showTotal
```
public boolean showTotal()
```

shouldTotal
```
public boolean shouldTotal()
```

setShouldTotal

public void setShouldTotal(boolean value)

shouldSort
```
public boolean shouldSort()
```

setShouldSort

public void setShouldSort(boolean value)

shouldRestrictToFirstRow

public boolean shouldRestrictToFirstRow()

setShouldRestrictToFirstRow

public void setShouldRestrictToFirstRow(boolean value)

label
```
public String label()
```

setLabel
```
public void setLabel(String value)
```

userInfo
```
public NSDictionary userInfo()
```

setUserInfo

public void setUserInfo(NSDictionary value)

isGroup
```
public boolean isGroup()
```

attributes
```
public NSMutableArray attributes()
```

flatAttributes
```
public NSArray flatAttributes()
```

flatAttributesTotal
```
public NSArray flatAttributesTotal()
```

flatAttributesWithDepthDictionary

protected NSArray flatAttributesWithDepthDictionary(int attributeListDepth,
                                                    NSMutableDictionary flatAttributeDepthDict)

setAttributeGroup

public void setAttributeGroup(DRAttributeGroup attributeGroup)

attributeGroup

public DRAttributeGroup attributeGroup()

isPlaceHolderTotal
```
public boolean isPlaceHolderTotal()
```

setIsPlaceHolderTotal

public void setIsPlaceHolderTotal(boolean value)

isComputed
```
public boolean isComputed()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

computeFromRawRecords

public double computeFromRawRecords(NSArray rawRecords)

Class DRAttribute

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_keyPath

_format

_shouldTotal

_shouldSort

_shouldRestrictToFirstRow

_isGroup

_label

_userInfo

_attributeGroup

_isPlaceHolderTotal

_isTotal

_isComputed

_emptyArray

Constructor Detail

DRAttribute

DRAttribute

DRAttribute

Method Detail

withAttributeGroup

withKeyPathFormatLabelTotalUserInfo

resetDefaults

keyPath

setKeyPath

format

setFormat

showTotal

shouldTotal

setShouldTotal

shouldSort

setShouldSort

shouldRestrictToFirstRow

setShouldRestrictToFirstRow

label

setLabel

userInfo

setUserInfo

isGroup

attributes

flatAttributes

flatAttributesTotal

flatAttributesWithDepthDictionary

setAttributeGroup

attributeGroup

isPlaceHolderTotal

setIsPlaceHolderTotal

isComputed

toString

computeFromRawRecords