Apache\Ignite\Type\CollectionObjectType Class Reference

Inheritance diagram for Apache\Ignite\Type\CollectionObjectType:

Public Member Functions
	__construct (int $subType, $elementType=null)
	getSubType ()
	getElementType ()
Public Member Functions inherited from Apache\Ignite\Type\ObjectType
	getTypeCode ()

Public Attributes
CollectionSubType
const	USER_SET = -1
const	USER_COL = 0
const	ARRAY_LIST = 1
const	LINKED_LIST = 2
const	HASH_SET = 3
const	LINKED_HASH_SET = 4
const	SINGLETON_LIST = 5
Public Attributes inherited from Apache\Ignite\Type\ObjectType
const	BYTE = 1
const	SHORT = 2
const	INTEGER = 3
const	LONG = 4
const	FLOAT = 5
const	DOUBLE = 6
const	CHAR = 7
const	BOOLEAN = 8
const	STRING = 9
const	UUID = 10
const	DATE = 11
const	BYTE_ARRAY = 12
const	SHORT_ARRAY = 13
const	INTEGER_ARRAY = 14
const	LONG_ARRAY = 15
const	FLOAT_ARRAY = 16
const	DOUBLE_ARRAY = 17
const	CHAR_ARRAY = 18
const	BOOLEAN_ARRAY = 19
const	STRING_ARRAY = 20
const	UUID_ARRAY = 21
const	DATE_ARRAY = 22
const	ENUM = 28
const	ENUM_ARRAY = 29
const	DECIMAL = 30
const	DECIMAL_ARRAY = 31
const	TIMESTAMP = 33
const	TIMESTAMP_ARRAY = 34
const	TIME = 36
const	TIME_ARRAY = 37
const	OBJECT_ARRAY = 23
const	COLLECTION = 24
const	MAP = 25
const	BINARY_OBJECT = 27
const	BINARY_ENUM = 38
const	NULL = 101
const	COMPLEX_OBJECT = 103

Detailed Description

Class representing a collection type of Ignite object.

It is described by ObjectType::COLLECTION and one of CollectionSubType.

Constructor & Destructor Documentation

__construct()

Apache\Ignite\Type\CollectionObjectType::__construct	(	int	$subType,
			$elementType = null
	)

Public constructor.

Specifies the collection subtype and optionally specifies Ignite type of elements in the collection.

If Ignite type of elements is not specified then during operations the Ignite client tries to make automatic mapping between PHP types and Ignite object types - according to the mapping table defined in the description of the ObjectType class.

Parameters

int	$subType	collection subtype, one of CollectionSubType constants.
int | ObjectType | null	$elementType	Ignite type of elements in the collection: either a type code of primitive (simple) type (PrimitiveTypeCodes) or an instance of class representing non-primitive (composite) type or null (or not specified) that means the type is not specified

Exceptions

ClientException

if error.

Member Function Documentation

getElementType()

Apache\Ignite\Type\CollectionObjectType::getElementType

(

)

Returns Ignite type of elements in the collection.

Returns

int|ObjectType|null type of elements in the collection:

• either a type code of primitive (simple) type (PrimitiveTypeCodes)
• or an instance of class representing non-primitive (composite) type
• or null that means the type is not specified

getSubType()

Apache\Ignite\Type\CollectionObjectType::getSubType

(

)

Returns collection subtype, one of CollectionSubType constants.

Returns

int collection subtype, one of CollectionSubType constants.

Member Data Documentation

ARRAY_LIST

const Apache\Ignite\Type\CollectionObjectType::ARRAY_LIST = 1

Resizeable array type.

HASH_SET

const Apache\Ignite\Type\CollectionObjectType::HASH_SET = 3

Basic hash set type.

LINKED_HASH_SET

const Apache\Ignite\Type\CollectionObjectType::LINKED_HASH_SET = 4

Hash set type, which maintains element order.

LINKED_LIST

const Apache\Ignite\Type\CollectionObjectType::LINKED_LIST = 2

Linked list type.

SINGLETON_LIST

const Apache\Ignite\Type\CollectionObjectType::SINGLETON_LIST = 5

This is a collection that only contains a single element, but behaves as a collection.

USER_COL

const Apache\Ignite\Type\CollectionObjectType::USER_COL = 0

General collection type, which can not be mapped to any specific collection type.

USER_SET

const Apache\Ignite\Type\CollectionObjectType::USER_SET = -1

General set type, which can not be mapped to more specific set type.

---

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

• src/Apache/Ignite/Type/CollectionObjectType.php