Event (InterSystems IRIS XEP Driver 3.0.0 API)

java.lang.Object
- com.intersystems.xep.AbstractEvent
- - com.intersystems.xep.Event

```
public class Event
extends AbstractEvent
```
Event.java provides methods that operate on XEP Events (storing events, creating a query, setting a filter, indexing etc)

Field Summary
- Fields inherited from class com.intersystems.xep.AbstractEvent
  GENERATED_KEYS, INDEX_MODE_ASYNC_OFF, INDEX_MODE_ASYNC_ON, INDEX_MODE_SYNC, indexMode, MAX_BUFFER_SIZE, NO_ID_KEYS, UPDATE_INDEXES, USER_KEYS

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Releases all resources held by this event.
`<E> EventQuery<E>`	`createQuery(String sqlText)` Create a EventQuery instance.
`void`	`deleteObject(long id)` Deletes an object given its database id.
`void`	`deleteObject(Object[] idkeys)` Deletes an object given its IDKEY.
`boolean`	`exists(com.intersystems.xep.internal.AbstractClassInfo classInfo, Object[] ids)` Note: This method is for internal use only.
`com.intersystems.xep.internal.ClassInfo`	`getClassInfo()`
`ListReader`	`getData(com.intersystems.xep.internal.AbstractClassInfo classInfo, Object[] ids)` Note: This method is for internal use only.
`static Object[]`	`getIdValues(Object object, com.intersystems.xep.internal.ClassInfo classInfo, boolean simple)` For internal use only
`Object`	`getObject(long id)` Retrieves an object given its database id.
`Object`	`getObject(Object[] idkeys)` Gets an object given its IDKEY.
`protected void`	`initIndexing()`
`static void`	`isEvent(Object objectOrClass)` Checks whether an object (or class) is an event in the XEP sense.
`void`	`parallelStore(Object[] objects, int splitFactor)` Stores an array of Java objects taking advantage of java.util.concurrent utilities for potential insert performance speedup.
`void`	`runBulkFetchTask(com.intersystems.xep.internal.ClassInfo classInfo, int start, int end)` Note: This method is for internal use only.
`void`	`runBulkStoreTask(int idKeyType, com.intersystems.xep.internal.ClassInfo classInfo, int objectCount)` Note: This method is for internal use only.
`void`	`runSerializeTask(Object[] objects, com.intersystems.xep.internal.ClassInfo classInfo, int start, int end)` Note: This method is for internal use only.
`void`	`runStoreTask(Object[] objects, com.intersystems.xep.internal.ClassInfo classInfo)` Note: This method is for internal use only.
`void`	`setData(com.intersystems.xep.internal.AbstractClassInfo classInfo, byte[] data, int length, Object[] idKeys)` Note: This method is for internal use only.
`void`	`startIndexing()` Start populating indexes asynchronously.
`void`	`stopIndexing()` Stop populating indexes asynchronously.
`long`	`store(Object object)` Stores the Java object.
`long[]`	`store(Object[] objects)` Stores an array of Java objects.
`void`	`updateObject(long id, Object object)` Updates an existing object given its database id.
`void`	`updateObject(Object[] idkeys, Object object)` Updates an object given its IDKEY.
`boolean`	`waitForIndexing(int timeout)` Wait for asynchronous indexing to be completed for this class.

Methods inherited from class com.intersystems.xep.AbstractEvent
bulkStore, storeSimpleObjectArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isEvent
```
public static void isEvent(Object objectOrClass)
```
    Checks whether an object (or class) is an event in the XEP sense.
    
    Parameters:
    
    objectOrClass - java object or class object
    
    Throws:
    
    XEPException - if the supplied object/class is an event in the XEP sense
  - getIdValues
```
public static Object[] getIdValues(Object object,
                                   com.intersystems.xep.internal.ClassInfo classInfo,
                                   boolean simple)
```
    For internal use only
    
    Parameters:
    
    object - object
    
    classInfo - classInfo
    
    simple - simple
    
    Returns:
    
    Object array
  - close
```
public final void close()
```
    Releases all resources held by this event.
  - store
```
public final long store(Object object)
```
    Stores the Java object.
    
    Parameters:
    
    object - Java object to be saved
    
    Returns:
    
    a database id of the newly inserted object, unless: 1) the application is using user defined keys (say by declaring an id field via the following annotation @Id(generated=false)) 2) other reasons (for example the database id could not be set) in which case the method will return 0.
  - store
```
public final long[] store(Object[] objects)
```
    Stores an array of Java objects.
    
    Parameters:
    
    objects - array of Java objects to be saved
    
    Returns:
    
    a long array representing database ids of the newly inserted objects, unless: 1) the underlying connection is TCP/IP (ids are not returned for performance reasons) 2) the application is using user defined keys (say by declaring an id field via the following annotation @Id(generated=false)) 3) other reasons (for example database ids could not be set) in which case the method will return either null, or a long[] filled with zeros.
  - parallelStore
```
public final void parallelStore(Object[] objects,
                                int splitFactor)
```
    Stores an array of Java objects taking advantage of java.util.concurrent utilities for potential insert performance speedup. It is important to note that the potential speedup would result from taking advantage of multiple threads/cores to serialize the data. Once the data is serialized, the rest of the store process will be equally I/O bound as the ordinary version of store. This method should be used only on multi-core machines. It is recommended that the non-parallel version of store is used to get the baseline insert rate numbers. Whether parallelStore performs better depends on the particular environment. Once the base line is obtained, and the number of cores is retrieved (for example by calling Runtime.getRuntime().availableProcessors()), it might be a good idea to experiment with different splitFactors to see if using parallelStore will result in performance boost. Please note that unlike the regular version, parallelStore does not (for performance reasons) return the ids of all the objects that were inserted. IMPORTANT NOTE: This method should only be used when no other threading either at the application, or at the XEP level is used.
    
    Parameters:
    
    objects - array of Java objects to be saved
    
    splitFactor - number of parallel tasks used to serialize the data
  - createQuery
```
public final <E> EventQuery<E> createQuery(String sqlText)
```
    Create a EventQuery instance.
    
    Type Parameters:
    
    E - type
    
    Parameters:
    
    sqlText - SQL text
    
    Returns:
    
    EventQuery instance
  - getObject
```
public final Object getObject(long id)
```
    Retrieves an object given its database id. Returns null if no object with this id exists.
    
    Parameters:
    
    id - database id
    
    Returns:
    
    Object an event object
  - updateObject
```
public final void updateObject(long id,
                               Object object)
```
    Updates an existing object given its database id.
    
    Parameters:
    
    id - database id
    
    object - new object
  - deleteObject
```
public final void deleteObject(long id)
```
    Deletes an object given its database id.
    
    Parameters:
    
    id - database id
  - getObject
```
public final Object getObject(Object[] idkeys)
```
    Gets an object given its IDKEY.
    
    Parameters:
    
    idkeys - composite IDKEY
    
    Returns:
    
    Object object
    
    Throws:
    
    XEPException - if the underlying class has no composite IDKEYs or if any of the keys supplied is equal to null or of an invalid type
  - updateObject
```
public final void updateObject(Object[] idkeys,
                               Object object)
```
    Updates an object given its IDKEY.
    
    Parameters:
    
    idkeys - composite IDKEY
    
    object - object to be updated
    
    Throws:
    
    XEPException - if the underlying class has no composite IDKEYs or if any of the keys supplied is equal to null or of an invalid type
  - deleteObject
```
public final void deleteObject(Object[] idkeys)
```
    Deletes an object given its IDKEY.
    
    Parameters:
    
    idkeys - composite IDKEY
    
    Throws:
    
    XEPException - if the underlying class has no composite IDKEYs or if any of the keys supplied is equal to null or of an invalid type
  - startIndexing
```
public final void startIndexing()
```
    Start populating indexes asynchronously. This method will throw an exception if called on an event created with INDEX_MODE_SYNC index mode.
  - stopIndexing
```
public final void stopIndexing()
```
    Stop populating indexes asynchronously. This method will throw an exception if called on an event created with INDEX_MODE_SYNC index mode.
  - waitForIndexing
```
public final boolean waitForIndexing(int timeout)
```
    Wait for asynchronous indexing to be completed for this class. If timeout is -1, wait forever or until indexing completes, else timeout after the specified number of seconds, returning false if indexing has not completed. If timeout is 0, immediately return true if indexing has completed or false if it has not. This method will throw an exception if called on an event created with INDEX_MODE_SYNC index mode. In ECP configurations, this method applies only to indexing of objects inserted via the current App Server.
    
    Parameters:
    
    timeout - Seconds to wait before timing out, -1 for no timeout (wait forever)
    
    Returns:
    
    true if indexing has completed, false if timed out before indexed completed
  - getData
```
public ListReader getData(com.intersystems.xep.internal.AbstractClassInfo classInfo,
                          Object[] ids)
```
    Note: This method is for internal use only.
    
    Parameters:
    
    classInfo - classInfo
    
    ids - ids
    
    Returns:
    
    byte[]
  - exists
```
public boolean exists(com.intersystems.xep.internal.AbstractClassInfo classInfo,
                      Object[] ids)
```
    Note: This method is for internal use only.
    
    Parameters:
    
    classInfo - classInfo
    
    ids - id values
    
    Returns:
    
    boolean
  - setData
```
public void setData(com.intersystems.xep.internal.AbstractClassInfo classInfo,
                    byte[] data,
                    int length,
                    Object[] idKeys)
```
    Note: This method is for internal use only.
    
    Parameters:
    
    classInfo - classInfo
    
    data - data
    
    length - length
    
    idKeys - id keys
  - initIndexing
```
protected void initIndexing()
```
  - runBulkStoreTask
```
public void runBulkStoreTask(int idKeyType,
                             com.intersystems.xep.internal.ClassInfo classInfo,
                             int objectCount)
                      throws Exception
```
    Note: This method is for internal use only.
    
    Parameters:
    
    idKeyType - id key type
    
    classInfo - class info
    
    objectCount - object count
    
    Throws:
    
    Exception - throws Exception
  - runStoreTask
```
public void runStoreTask(Object[] objects,
                         com.intersystems.xep.internal.ClassInfo classInfo)
                  throws Exception
```
    Note: This method is for internal use only.
    
    Parameters:
    
    objects - objects
    
    classInfo - class info
    
    Throws:
    
    Exception - throws Exception
  - runSerializeTask
```
public final void runSerializeTask(Object[] objects,
                                   com.intersystems.xep.internal.ClassInfo classInfo,
                                   int start,
                                   int end)
                            throws InterruptedException
```
    Note: This method is for internal use only.
    
    Parameters:
    
    objects - objects
    
    classInfo - class info
    
    start - start
    
    end - end
    
    Throws:
    
    InterruptedException - throws InterruptedException
  - runBulkFetchTask
```
public void runBulkFetchTask(com.intersystems.xep.internal.ClassInfo classInfo,
                             int start,
                             int end)
                      throws Exception
```
    Note: This method is for internal use only.
    
    Parameters:
    
    classInfo - class info
    
    start - start
    
    end - end
    
    Throws:
    
    Exception - throws Exception
  - getClassInfo
```
public com.intersystems.xep.internal.ClassInfo getClassInfo()
```
    Specified by:
    
    getClassInfo in class AbstractEvent

Class Event

Field Summary

Fields inherited from class com.intersystems.xep.AbstractEvent

Method Summary

Methods inherited from class com.intersystems.xep.AbstractEvent

Methods inherited from class java.lang.Object

Method Detail

isEvent

getIdValues

close

store

store

parallelStore

createQuery

getObject

updateObject

deleteObject

getObject

updateObject

deleteObject

startIndexing

stopIndexing

waitForIndexing

getData

exists

setData

initIndexing

runBulkStoreTask

runStoreTask

runSerializeTask

runBulkFetchTask

getClassInfo