STSAttribute Class Reference

Attribute data class. More...

#include <Sparksee.h>

Inheritance diagram for STSAttribute:

Collaboration diagram for STSAttribute:

Instance Methods
(int)	- getId
	Gets the Sparksee attribute identifier.
(int)	- getTypeId
	Gets the Sparksee type identifier.
(NSString *)	- getName
	Gets the unique attribute name.
(enum STSDataType)	- getDataType
	Gets the data type.
(long long)	- getSize
	Gets the number of different values.
(long long)	- getCount
	Gets the number of non-NULL values.
(enum STSAttributeKind)	- getKind
	Gets the attribute kind.
(BOOL)	- isSessionAttribute
	Check if it's a session attribute or a persistent one.
(STSValue *)	- getDefaultValue
	Gets the default value for this attribute.
(BOOL)	- isArrayAttribute
	Check if it's an array attribute.
(int)	- getArraySize
	Gets the number of elements in the array.

Class Methods
(int)	+ getInvalidAttribute
	Invalid attribute identifier constant.

Detailed Description

Attribute data class.

It contains information about an attribute.

Author

Sparsity Technologies http://www.sparsity-technologies.com

Method Documentation

getArraySize

- (int) getArraySize

Gets the number of elements in the array.

Returns

The size of the array

References getArraySize.

Referenced by getArraySize.

getCount

- (long long) getCount

Gets the number of non-NULL values.

Returns

The number of non-NULL values.

References getCount.

Referenced by getCount.

getDataType

- (enum STSDataType) getDataType

Gets the data type.

Returns

The DataType.

References getDataType.

Referenced by getDataType.

getDefaultValue

- (STSValue *) getDefaultValue

Gets the default value for this attribute.

Returns

A new Value instance with the default value, or NULL if none is set.

References getDefaultValue.

Referenced by getDefaultValue.

getId

- (int) getId

Gets the Sparksee attribute identifier.

Returns

The Sparksee attribute identifier.

References getId.

Referenced by getId.

getKind

- (enum STSAttributeKind) getKind

Gets the attribute kind.

Returns

The AttributeKind.

References getKind.

Referenced by getKind.

getName

- (NSString *) getName

Gets the unique attribute name.

Returns

The unique attribute name.

References getName.

Referenced by getName.

getSize

- (long long) getSize

Gets the number of different values.

Returns

The number of different values.

References getSize.

Referenced by getSize.

getTypeId

- (int) getTypeId

Gets the Sparksee type identifier.

Returns

The Sparksee type identifier.

References getTypeId.

Referenced by getTypeId.

isArrayAttribute

- (BOOL) isArrayAttribute

Check if it's an array attribute.

Returns

True if it's an array attribute, or false otherwise.

References isArrayAttribute.

Referenced by isArrayAttribute.

isSessionAttribute

- (BOOL) isSessionAttribute

Check if it's a session attribute or a persistent one.

Returns

True if it's a session attribute, or false otherwise.

References isSessionAttribute.

Referenced by isSessionAttribute.

---

The documentation for this class was generated from the following file:

• Sparksee.h