com.tibco.cep.runtime.model.element

Interface PropertyArrayConceptReference

All Superinterfaces:

PropertyArrayConcept

public interface PropertyArrayConceptReference
extends PropertyArrayConcept

Property that contains zero, one, or multiple PropertyAtomConceptReference.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
int	add(Concept instance) Creates a PropertyAtomConceptReference with with a reference to the given instance, and appends it to the end of the array.
void	add(int index, Concept instance) Creates a PropertyAtomConceptReference and inserts it at the specified position in the array.
PropertyAtomConceptReference	getPropertyAtomConceptReference(Concept instance) Finds the first PropertyAtomConceptReference referring to the given instance in this array.
int	put(Concept instance) Returns the index of the PropertyAtomConceptReference in this array that refers to the given Concept, if any, otherwise creates a PropertyAtomConceptReference that refers to the instance and appends it to the end of the array.
PropertyAtomConceptReference	remove(Concept instance) Removes the first PropertyAtomConceptReference referring to the given instance that is found in this array.
PropertyAtomConceptReference	removePropertyAtom(Concept instance) Removes the first occurrence of PropertyConceptReference which is a reference to the given instance, and returns it.
void	set(int index, Concept value) Sets the PropertyConceptReference at the given index to a reference to the given Concept.

Method Detail

add

int add(Concept instance)

Creates a PropertyAtomConceptReference with with a reference to the given instance, and appends it to the end of the array. This method doesn't check for duplicates (i.e. existence of references to the same instance" in the array).

Parameters:

instance - the target Concept of the reference to append to this array.

Returns:

the index at which the reference is inserted.

Since:

2.0.0

add

void add(int index,
         Concept instance)

Creates a PropertyAtomConceptReference and inserts it at the specified position in the array. Shifts the PropertyAtomConceptReference currently at that position (if any) and any subsequent PropertyAtomConceptReference to the right (i.e. adds one to their indices).

Parameters:

index - at which the reference is to be inserted

instance - the target Concept of the reference to append to this array.

Throws:

java.lang.IndexOutOfBoundsException - if index is less than zero or more than the current size of the array.

Since:

2.0.0

put

int put(Concept instance)

Returns the index of the PropertyAtomConceptReference in this array that refers to the given Concept, if any, otherwise creates a PropertyAtomConceptReference that refers to the instance and appends it to the end of the array.

Parameters:

instance - the Concept to search for in this array, or to which a new reference will be added.

Returns:

the index at which the instance is found or inserted.

Since:

2.0.0

remove

PropertyAtomConceptReference remove(Concept instance)

Removes the first PropertyAtomConceptReference referring to the given instance that is found in this array.

Parameters:

instance - the Conceptto search for in the array.

Returns:

the first PropertyAtomConceptReference referring to the given instance that is found in this array, or null if none was found.

Since:

2.0.0

getPropertyAtomConceptReference

PropertyAtomConceptReference getPropertyAtomConceptReference(Concept instance)

Finds the first PropertyAtomConceptReference referring to the given instance in this array.

Parameters:

instance - the Concept instance to search for in the array.

Returns:

the PropertyAtomConceptReference that was found, or null if none was not found.

Since:

2.0.0

set

void set(int index,
         Concept value)

Sets the PropertyConceptReference at the given index to a reference to the given Concept. If index == length, this method will call add(index, value) instead.

Parameters:

index - the index at which the reference is to be set.

value - the target Concept for the new reference value.

Throws:

java.lang.IndexOutOfBoundsException - - if the index is less than zero or more than the current size of the array.

Since:

2.0.0

removePropertyAtom

PropertyAtomConceptReference removePropertyAtom(Concept instance)

Removes the first occurrence of PropertyConceptReference which is a reference to the given instance, and returns it. This method shifts all the subsequent array elements to the left (i.e. substracts one to their indices). It returns null if no PropertyConceptReference is found.

Parameters:

instance - the instance to search for.

Returns:

the removed PropertyConceptReference if any, else null.

Since:

2.0.0