Apache\Ignite\Type\MapObjectType Class Reference

Inheritance diagram for Apache\Ignite\Type\MapObjectType:

Public Member Functions
	__construct (int $subType=MapObjectType::HASH_MAP, $keyType=null, $valueType=null)
	getSubType ()
	getKeyType ()
	getValueType ()
Public Member Functions inherited from Apache\Ignite\Type\ObjectType
	getTypeCode ()

Public Attributes
MapSubType
const	HASH_MAP = 1
const	LINKED_HASH_MAP = 2
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 map type of Ignite object.

It is described by ObjectType::MAP and one of MapSubType.

Constructor & Destructor Documentation

__construct()

Apache\Ignite\Type\MapObjectType::__construct	(	int	$subType = MapObjectType::HASH_MAP,
			$keyType = null,
			$valueType = null
	)

Public constructor.

Optionally specifies the map subtype and Ignite types of keys and values in the map.

If the map subtype is not specified, MapObjectType::HASH_MAP is assumed.

If Ignite type is not specified for the key and/or value 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	map subtype, one of MapSubType constants.
int | ObjectType | null	$keyType	Ignite type of the keys in the map: 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
int | ObjectType | null	$valueType	Ignite type of the values in the map: 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

getKeyType()

Apache\Ignite\Type\MapObjectType::getKeyType

(

)

Returns Ignite type of the keys in the map.

Returns

int|ObjectType|null type of the keys in the map:

• 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\MapObjectType::getSubType

(

)

Returns the map subtype, one of MapSubType constants.

Returns

int map subtype, one of MapSubType constants.

getValueType()

Apache\Ignite\Type\MapObjectType::getValueType

(

)

Returns Ignite type of the values in the map.

Returns

int|ObjectType|null type of the values in the map:

• 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

Member Data Documentation

HASH_MAP

const Apache\Ignite\Type\MapObjectType::HASH_MAP = 1

Basic hash map.

LINKED_HASH_MAP

const Apache\Ignite\Type\MapObjectType::LINKED_HASH_MAP = 2

Hash map, which maintains element order.

---

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

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