Modules
	afw_adaptor_impl_index

Data Structures
struct	afw_adaptor_impl_index_s
	Interface afw_adaptor_impl_index public struct. More...

struct	afw_adaptor_impl_index_inf_s
	Interface afw_adaptor_impl_index_inf_s struct. More...

Macros
#define	AFW_ADAPTOR_IMPL_INDEX_INTERFACE_NAME "afw_adaptor_impl_index"
	define for interface afw_adaptor_impl_index name.

#define	afw_adaptor_impl_index_open(instance, object_type_id, key, integer, unique, reverse, pool, xctx)
	Call method open of interface afw_adaptor_impl_index. More...

#define	afw_adaptor_impl_index_release(instance, xctx)
	Call method release of interface afw_adaptor_impl_index. More...

#define	afw_adaptor_impl_index_get_index_definitions(instance, xctx)
	Call method get_index_definitions of interface afw_adaptor_impl_index. More...

#define	afw_adaptor_impl_index_update_index_definitions(instance, indexDefinitions, xctx)
	Call method update_index_definitions of interface afw_adaptor_impl_index. More...

#define	afw_adaptor_impl_index_add(instance, object_type_id, object_id, key, value, unique, pool, xctx)
	Call method add of interface afw_adaptor_impl_index. More...

#define	afw_adaptor_impl_index_delete(instance, object_type_id, object_id, key, value, pool, xctx)
	Call method delete of interface afw_adaptor_impl_index. More...

#define	afw_adaptor_impl_index_replace(instance, object_type_id, object_id, key, old_value, new_value, pool, xctx)
	Call method replace of interface afw_adaptor_impl_index. More...

#define	afw_adaptor_impl_index_drop(instance, object_type_id, key, pool, xctx)
	Call method drop of interface afw_adaptor_impl_index. More...

#define	afw_adaptor_impl_index_open_cursor(instance, object_type_id, index_key, operator, value, unique, pool, xctx)
	Call method open_cursor of interface afw_adaptor_impl_index. More...

#define	afw_adaptor_impl_index_get_session(instance, xctx)
	Call method get_session of interface afw_adaptor_impl_index. More...

Typedefs
typedef void(*	afw_adaptor_impl_index_open_t) (const afw_adaptor_impl_index_t instance, const afw_utf8_t object_type_id, const afw_utf8_t key, afw_boolean_t integer, afw_boolean_t unique, afw_boolean_t reverse, const afw_pool_t pool, afw_xctx_t *xctx)

typedef void(*	afw_adaptor_impl_index_release_t) (const afw_adaptor_impl_index_t instance, afw_xctx_t xctx)

typedef const afw_object_t (	afw_adaptor_impl_index_get_index_definitions_t) (const afw_adaptor_impl_index_t instance, afw_xctx_t xctx)

typedef void(*	afw_adaptor_impl_index_update_index_definitions_t) (const afw_adaptor_impl_index_t instance, const afw_object_t indexDefinitions, afw_xctx_t *xctx)

typedef afw_rc_t(*	afw_adaptor_impl_index_add_t) (const afw_adaptor_impl_index_t instance, const afw_utf8_t object_type_id, const afw_utf8_t object_id, const afw_utf8_t key, const afw_utf8_t value, afw_boolean_t unique, const afw_pool_t pool, afw_xctx_t *xctx)

typedef afw_rc_t(*	afw_adaptor_impl_index_delete_t) (const afw_adaptor_impl_index_t instance, const afw_utf8_t object_type_id, const afw_utf8_t object_id, const afw_utf8_t key, const afw_utf8_t value, const afw_pool_t pool, afw_xctx_t *xctx)

typedef afw_rc_t(*	afw_adaptor_impl_index_replace_t) (const afw_adaptor_impl_index_t instance, const afw_utf8_t object_type_id, const afw_utf8_t object_id, const afw_utf8_t key, const afw_utf8_t old_value, const afw_utf8_t new_value, const afw_pool_t pool, afw_xctx_t xctx)

typedef afw_rc_t(*	afw_adaptor_impl_index_drop_t) (const afw_adaptor_impl_index_t instance, const afw_utf8_t object_type_id, const afw_utf8_t key, const afw_pool_t pool, afw_xctx_t *xctx)

typedef afw_adaptor_impl_index_cursor_t (	afw_adaptor_impl_index_open_cursor_t) (const afw_adaptor_impl_index_t instance, const afw_utf8_t object_type_id, const afw_utf8_t index_key, int operator, const afw_utf8_t value, afw_boolean_t unique, const afw_pool_t pool, afw_xctx_t xctx)

typedef const afw_adaptor_session_t (	afw_adaptor_impl_index_get_session_t) (const afw_adaptor_impl_index_t instance, afw_xctx_t xctx)

Detailed Description

Adaptor implementation index interface.

Macro Definition Documentation

◆ afw_adaptor_impl_index_add

#define afw_adaptor_impl_index_add	(	instance,
		object_type_id,
		object_id,
		key,
		value,
		unique,
		pool,
		xctx
	)

Value:

(instance)->inf->add( \
    (instance), \
    (object_type_id), \
    (object_id), \
    (key), \
    (value), \
    (unique), \
    (pool), \
    (xctx) \
)

Call method add of interface afw_adaptor_impl_index.

Parameters

instance	Pointer to this adaptor impl index instance.
object_type_id	Object type id associated with the property and value that we are indexing. This may be useful for the adaptor to determine the target table or database to store the index.
object_id	Object id for the object associated with the property and value that we are indexing. This should be used by the adaptor as a reference to the primary entry.
key	Index key associated with the index value we are creating.
value	Index value associated with the index we are creating. This should be used by the adaptor as the key to the index entry.
unique	Flag indicating that the index being added should be unique.
pool	Caller's pool.
xctx	This is the caller's xctx.

Definition at line 1470 of file afw_interface.h.

◆ afw_adaptor_impl_index_delete

#define afw_adaptor_impl_index_delete	(	instance,
		object_type_id,
		object_id,
		key,
		value,
		pool,
		xctx
	)

Value:

(instance)->inf->delete( \
    (instance), \
    (object_type_id), \
    (object_id), \
    (key), \
    (value), \
    (pool), \
    (xctx) \
)

Call method delete of interface afw_adaptor_impl_index.

Parameters

instance	Pointer to this adaptor impl index instance.
object_type_id	Object type id associated with the property and value of the index we are removing. This may be useful for the adaptor to determine the target table or database to store the index.
object_id	Object id for the object associated with the property and value of the index we are removing. This should be used by the adaptor as a reference to the primary entry.
key	Index key associated with the index value we are deleting.
value	Index value associated with the index we are deleting. This should be used by the adaptor as the key to the index entry.
pool	Caller's pool.
xctx	This is the caller's xctx.

Definition at line 1506 of file afw_interface.h.

◆ afw_adaptor_impl_index_drop

#define afw_adaptor_impl_index_drop	(	instance,
		object_type_id,
		key,
		pool,
		xctx
	)

Value:

(instance)->inf->drop( \
    (instance), \
    (object_type_id), \
    (key), \
    (pool), \
    (xctx) \
)

Call method drop of interface afw_adaptor_impl_index.

Parameters

instance	Pointer to this adaptor impl index instance.
object_type_id	Object type id associated with the index. This may be useful for the adaptor to determine the target table or database for the index.
key	Index key.
pool	Caller's pool.
xctx	This is the caller's xctx.

Definition at line 1573 of file afw_interface.h.

◆ afw_adaptor_impl_index_get_index_definitions

#define afw_adaptor_impl_index_get_index_definitions	(	instance,
		xctx
	)

Value:

(instance)->inf->get_index_definitions( \
    (instance), \
    (xctx) \
)

Call method get_index_definitions of interface afw_adaptor_impl_index.

Parameters

instance	Pointer to this adaptor impl index instance.
xctx	This is the caller's xctx.

Definition at line 1427 of file afw_interface.h.

◆ afw_adaptor_impl_index_get_session

#define afw_adaptor_impl_index_get_session	(	instance,
		xctx
	)

Value:

(instance)->inf->get_session( \
    (instance), \
    (xctx) \
)

Call method get_session of interface afw_adaptor_impl_index.

Parameters

instance	Pointer to this adaptor impl index instance.
xctx	This is the caller's xctx.

Definition at line 1628 of file afw_interface.h.

◆ afw_adaptor_impl_index_open

#define afw_adaptor_impl_index_open	(	instance,
		object_type_id,
		key,
		integer,
		unique,
		reverse,
		pool,
		xctx
	)

Value:

(instance)->inf->open( \
    (instance), \
    (object_type_id), \
    (key), \
    (integer), \
    (unique), \
    (reverse), \
    (pool), \
    (xctx) \
)

Call method open of interface afw_adaptor_impl_index.

Parameters

instance	Pointer to this adaptor impl index instance.
object_type_id	Object type id associated with the property and value that we are indexing. This may be useful for the adaptor to determine the target table or database to store the index. NULL means all objectTypes are applicable.
key	Index key associated with the index value we are creating.
integer	Should index values be stored as integer values.
unique	Should generated index values be unique.
reverse	Should index values be stored in reverse order.
pool	Caller's pool.
xctx	This is the caller's xctx.

Definition at line 1387 of file afw_interface.h.

◆ afw_adaptor_impl_index_open_cursor

#define afw_adaptor_impl_index_open_cursor	(	instance,
		object_type_id,
		index_key,
		operator,
		value,
		unique,
		pool,
		xctx
	)

Value:

(instance)->inf->open_cursor( \
    (instance), \
    (object_type_id), \
    (index_key), \
    (operator), \
    (value), \
    (unique), \
    (pool), \
    (xctx) \
)

Call method open_cursor of interface afw_adaptor_impl_index.

Parameters

instance	Pointer to this adaptor impl index instance.
object_type_id	Object type id associated with the property and value that we are indexing. This may be useful for the adaptor to determine the target table or database to find the index.
index_key	Key associated with the index we are replacing.
operator	Query criteria operator.
value	Index value associated with the index we are querying. This should be used by the adaptor as the key to the index entry.
unique	Index values are unique.
pool	Caller's pool.
xctx	This is the caller's xctx.

Definition at line 1602 of file afw_interface.h.

◆ afw_adaptor_impl_index_release

#define afw_adaptor_impl_index_release	(	instance,
		xctx
	)

Value:

(instance)->inf->release( \
    (instance), \
    (xctx) \
)

Call method release of interface afw_adaptor_impl_index.

Parameters

instance	Pointer to this adaptor impl index instance.
xctx	This is the caller's xctx.

Definition at line 1413 of file afw_interface.h.

◆ afw_adaptor_impl_index_replace

#define afw_adaptor_impl_index_replace	(	instance,
		object_type_id,
		object_id,
		key,
		old_value,
		new_value,
		pool,
		xctx
	)

Value:

(instance)->inf->replace( \
    (instance), \
    (object_type_id), \
    (object_id), \
    (key), \
    (old_value), \
    (new_value), \
    (pool), \
    (xctx) \
)

Call method replace of interface afw_adaptor_impl_index.

Parameters

instance	Pointer to this adaptor impl index instance.
object_type_id	Object type id associated with the property and value that we are indexing. This may be useful for the adaptor to determine the target table or database to store the index.
object_id	Object id for the object associated with the property and value that we are indexing. This should be used by the adaptor as a reference to the primary entry.
key	Index key associated with the index value we are replacing.
old_value	Old index value associated with the index we are replacing. This should be used by the adaptor as the key to the index entry.
new_value	New index value associated with the index we are replacing. This should be used by the adaptor as the key to the index entry.
pool	Caller's pool.
xctx	This is the caller's xctx.

Definition at line 1542 of file afw_interface.h.

◆ afw_adaptor_impl_index_update_index_definitions

#define afw_adaptor_impl_index_update_index_definitions	(	instance,
		indexDefinitions,
		xctx
	)

Value:

(instance)->inf->update_index_definitions( \
    (instance), \
    (indexDefinitions), \
    (xctx) \
)

Call method update_index_definitions of interface afw_adaptor_impl_index.

Parameters

instance	Pointer to this adaptor impl index instance.
indexDefinitions	Updated indexes definitions.
xctx	This is the caller's xctx.

Definition at line 1443 of file afw_interface.h.

Typedef Documentation

◆ afw_adaptor_impl_index_add_t

typedef afw_rc_t(* afw_adaptor_impl_index_add_t) (const afw_adaptor_impl_index_t *instance, const afw_utf8_t *object_type_id, const afw_utf8_t *object_id, const afw_utf8_t *key, const afw_utf8_t *value, afw_boolean_t unique, const afw_pool_t *pool, afw_xctx_t *xctx)

See also: afw_adaptor_impl_index_add()

Definition at line 1297 of file afw_interface.h.

◆ afw_adaptor_impl_index_delete_t

typedef afw_rc_t(* afw_adaptor_impl_index_delete_t) (const afw_adaptor_impl_index_t *instance, const afw_utf8_t *object_type_id, const afw_utf8_t *object_id, const afw_utf8_t *key, const afw_utf8_t *value, const afw_pool_t *pool, afw_xctx_t *xctx)

See also: afw_adaptor_impl_index_delete()

Definition at line 1309 of file afw_interface.h.

◆ afw_adaptor_impl_index_drop_t

typedef afw_rc_t(* afw_adaptor_impl_index_drop_t) (const afw_adaptor_impl_index_t *instance, const afw_utf8_t *object_type_id, const afw_utf8_t *key, const afw_pool_t *pool, afw_xctx_t *xctx)

See also: afw_adaptor_impl_index_drop()

Definition at line 1332 of file afw_interface.h.

◆ afw_adaptor_impl_index_get_index_definitions_t

typedef const afw_object_t*(* afw_adaptor_impl_index_get_index_definitions_t) (const afw_adaptor_impl_index_t *instance, afw_xctx_t *xctx)

See also: afw_adaptor_impl_index_get_index_definitions()

Definition at line 1284 of file afw_interface.h.

◆ afw_adaptor_impl_index_get_session_t

typedef const afw_adaptor_session_t*(* afw_adaptor_impl_index_get_session_t) (const afw_adaptor_impl_index_t *instance, afw_xctx_t *xctx)

See also: afw_adaptor_impl_index_get_session()

Definition at line 1353 of file afw_interface.h.

◆ afw_adaptor_impl_index_open_cursor_t

typedef afw_adaptor_impl_index_cursor_t*(* afw_adaptor_impl_index_open_cursor_t) (const afw_adaptor_impl_index_t *instance, const afw_utf8_t *object_type_id, const afw_utf8_t *index_key, int operator,const afw_utf8_t *value, afw_boolean_t unique, const afw_pool_t *pool, afw_xctx_t *xctx)

See also: afw_adaptor_impl_index_open_cursor()

Definition at line 1341 of file afw_interface.h.

◆ afw_adaptor_impl_index_open_t

typedef void(* afw_adaptor_impl_index_open_t) (const afw_adaptor_impl_index_t *instance, const afw_utf8_t *object_type_id, const afw_utf8_t *key, afw_boolean_t integer, afw_boolean_t unique, afw_boolean_t reverse, const afw_pool_t *pool, afw_xctx_t *xctx)

See also: afw_adaptor_impl_index_open()

Definition at line 1266 of file afw_interface.h.

◆ afw_adaptor_impl_index_release_t

typedef void(* afw_adaptor_impl_index_release_t) (const afw_adaptor_impl_index_t *instance, afw_xctx_t *xctx)

See also: afw_adaptor_impl_index_release()

Definition at line 1278 of file afw_interface.h.

◆ afw_adaptor_impl_index_replace_t

typedef afw_rc_t(* afw_adaptor_impl_index_replace_t) (const afw_adaptor_impl_index_t *instance, const afw_utf8_t *object_type_id, const afw_utf8_t *object_id, const afw_utf8_t *key, const afw_utf8_t *old_value, const afw_utf8_t *new_value, const afw_pool_t *pool, afw_xctx_t *xctx)

See also: afw_adaptor_impl_index_replace()

Definition at line 1320 of file afw_interface.h.

◆ afw_adaptor_impl_index_update_index_definitions_t

typedef void(* afw_adaptor_impl_index_update_index_definitions_t) (const afw_adaptor_impl_index_t *instance, const afw_object_t *indexDefinitions, afw_xctx_t *xctx)

See also: afw_adaptor_impl_index_update_index_definitions()

Definition at line 1290 of file afw_interface.h.

Modules

Data Structures

Macros

Typedefs

Detailed Description

Macro Definition Documentation

◆ afw_adaptor_impl_index_add

◆ afw_adaptor_impl_index_delete

◆ afw_adaptor_impl_index_drop

◆ afw_adaptor_impl_index_get_index_definitions

◆ afw_adaptor_impl_index_get_session

◆ afw_adaptor_impl_index_open

◆ afw_adaptor_impl_index_open_cursor

◆ afw_adaptor_impl_index_release

◆ afw_adaptor_impl_index_replace

◆ afw_adaptor_impl_index_update_index_definitions

Typedef Documentation

◆ afw_adaptor_impl_index_add_t

◆ afw_adaptor_impl_index_delete_t

◆ afw_adaptor_impl_index_drop_t

◆ afw_adaptor_impl_index_get_index_definitions_t

◆ afw_adaptor_impl_index_get_session_t

◆ afw_adaptor_impl_index_open_cursor_t

◆ afw_adaptor_impl_index_open_t

◆ afw_adaptor_impl_index_release_t

◆ afw_adaptor_impl_index_replace_t

◆ afw_adaptor_impl_index_update_index_definitions_t