Annotation Interface CQAttribute

@Retention(RUNTIME)
@Target(METHOD)
public @interface CQAttribute

Method-level, run-time annotation defining two attributes:

1. attribute: defines CQEngine attribute type associated with get method. CQEngine uses this attribute to retrieve an event value.
2. index: defines CQEngine index for attribute. If not defined, then attribute has no index.

If a public returntype getXXX() method is not annotated with @CQAttribute, then no CQEngine attribute is generated for the method.

Author:

Charles W. Rapp

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
CQAttributeType	attribute	Returns CQEngine attribute type used for a public getXXX() method.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
CQIndexType	index	Returns CQEngine attribute index type associated with the get method attribute.
boolean	nullValues	Returns true if a multi-value field contains null values; otherwise returns false.

Element Details

attribute

CQAttributeType attribute

Returns CQEngine attribute type used for a public getXXX() method. There is no default value. If this annotation is not provided for a get method, then no CQEngine attribute is created for that field.

Returns:

CQEngine attribute type.

See Also:

• CQAttributeType

nullValues

boolean nullValues

Returns true if a multi-value field contains null values; otherwise returns false. If not specified, then defaults to false.

This field should be used only when attribute() is set to CQAttributeType.MULTIVALUE_NULLABLE. This flag is ignored for all other attribute types.

Returns:

true if a multi-value field contains null values.

See Also:

• attribute()

Default:

false

index

CQIndexType index

Returns CQEngine attribute index type associated with the get method attribute. If not specified, then defaults to NO_INDEX.

Returns:

CQEngine index type.

See Also:

• CQIndexType

Default:

NO_INDEX