Cumulus (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.Cumulus

```
public class Cumulus
extends java.lang.Object
```
The base class of the Cumulus Java Classes library. You need to call the CumulusStart() method to initialize the Cumulus Java Classes library. Call the CumulusStop() method when you are finished using the Cumulus Java Classes. To start a new session call the newSession() method.

Since:

1.0

See Also:
CumulusSession

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FindAfter` Token ID for the "after" find token.
`static int`	`FindAnd` Token ID for the "and" find token.
`static int`	`FindBoolFalse` Token ID for the "false" find token.
`static int`	`FindBoolTrue` Token ID for the "true" find token.
`static int`	`FindCategoriesField` Token ID for the "Categories" field name find token.
`static int`	`FindContains` Token ID for the "contains" find token.
`static int`	`FindDoesntContain` Token ID for the "doesn't cont." find token.
`static int`	`FindFrom` Token ID for the "from" find token.
`static int`	`FindHasNoValue` Token ID for the "has no value to" find token.
`static int`	`FindHasValue` Token ID for the "has value to" find token.
`static int`	`FindIs` Token ID for the "is" find token.
`static int`	`FindIsNot` Token ID for the "is not" find token.
`static int`	`FindOr` Token ID for the "or" find token.
`static int`	`FindOver` Token ID for the "over" find token.
`static int`	`FindPriorTo` Token ID for the "prior to" find token.
`static int`	`FindStartsWith` Token ID for the "starts with" find token.
`static int`	`FindThumbNotSimilar` Token ID for the "not similar to" find token.
`static int`	`FindThumbSimilar` Token ID for the "similar to" find token.
`static int`	`FindUnder` Token ID for the "under" find token.
`static int`	`FindUpTo` Token ID for the "up to" find token.
`static int`	`IndexKindContentIndexed` Field index kind value for fields that are indexed for contain searching only.
`static int`	`IndexKindNotIndexed` Field index kind value for fields that are not indexed.
`static int`	`IndexKindOptionalFlagSegmentedIndex` Field index kind flag for segmented indices.
`static int`	`IndexKindOptionalFlagSolrIndex` Field index kind flag for Solr-based indices.
`static int`	`IndexKindOptionalFlagWithoutWordBreak` Field index kind flag for content indices without word break.
`static int`	`IndexKindSortContentIndexed` Field index kind value for fields that are indexed for sorting and contain searching.
`static int`	`IndexKindSortIndexed` Field index kind value for fields that are indexed for sorting only.
`static int`	`IndexKindWordIndexed` Field index kind value for fields that are word indexed.
`static java.lang.String`	`READ_ONLY_SERIAL_NUMBER` The Toolbox Runtime RO serial number to provide for read-only access in the `Server.openConnection(boolean, String, String, String)` method.
`static java.lang.String`	`READ_WRITE_SERIAL_NUMBER` The Toolbox Runtime RW serial number to provide for read-write access in the `Server.openConnection(boolean, String, String, String)` connectToServer} method.
`static java.lang.String`	`TABLE_NAME_ASSET_RECORDS`
`static java.lang.String`	`TABLE_NAME_CATEGORIES`
`static int`	`VERSION_NUMBER_10_0` Constant value for version 10.0.
`static int`	`VERSION_NUMBER_10_0_1` Constant value for version 10.0.1.
`static int`	`VERSION_NUMBER_10_0_2` Constant value for version 10.0.2.
`static int`	`VERSION_NUMBER_10_0_3` Constant value for version 10.0.3.
`static int`	`VERSION_NUMBER_10_1` Constant value for version 10.1.
`static int`	`VERSION_NUMBER_10_1_1` Constant value for version 10.1.1.
`static int`	`VERSION_NUMBER_10_1_2` Constant value for version 10.1.2.
`static int`	`VERSION_NUMBER_10_1_3` Constant value for version 10.1.3.
`static int`	`VERSION_NUMBER_10_2` Constant value for version 10.2.
`static int`	`VERSION_NUMBER_10_2_1` Constant value for version 10.2.1.
`static int`	`VERSION_NUMBER_10_2_2` Constant value for version 10.2.2.
`static int`	`VERSION_NUMBER_10_2_3` Constant value for version 10.2.3.
`static int`	`VERSION_NUMBER_10_2_4` Constant value for version 10.2.4.
`static int`	`VERSION_NUMBER_10_2_5` Constant value for version 10.2.5.
`static int`	`VERSION_NUMBER_10_2_6` Constant value for version 10.2.6.
`static int`	`VERSION_NUMBER_10_2_7` Constant value for version 10.2.7.
`static int`	`VERSION_NUMBER_11_0` Constant value for version 11.0.
`static int`	`VERSION_NUMBER_11_0_1` Constant value for version 11.0.1.
`static int`	`VERSION_NUMBER_11_0_2` Constant value for version 11.0.2.
`static int`	`VERSION_NUMBER_11_0_3` Constant value for version 11.0.3.
`static int`	`VERSION_NUMBER_11_0_4` Constant value for version 11.0.4.
`static int`	`VERSION_NUMBER_11_1` Constant value for version 11.1.
`static int`	`VERSION_NUMBER_11_1_1` Constant value for version 11.1.1.
`static int`	`VERSION_NUMBER_11_1_2` Constant value for version 11.1.2.
`static int`	`VERSION_NUMBER_11_1_3` Constant value for version 11.1.3.
`static int`	`VERSION_NUMBER_11_1_4` Constant value for version 11.1.4.
`static int`	`VERSION_NUMBER_11_1_5` Constant value for version 11.1.5.
`static int`	`VERSION_NUMBER_11_1_6` Constant value for version 11.1.6.
`static int`	`VERSION_NUMBER_11_1_7` Constant value for version 11.1.7.
`static int`	`VERSION_NUMBER_6_0` Constant value for version 6.0.
`static int`	`VERSION_NUMBER_7_0` Constant value for version 7.0.
`static int`	`VERSION_NUMBER_7_5` Constant value for version 7.5.
`static int`	`VERSION_NUMBER_7_5_3` Constant value for version 7.5.3.
`static int`	`VERSION_NUMBER_7_5_4` Constant value for version 7.5.4.
`static int`	`VERSION_NUMBER_7_6` Constant value for version 7.6.
`static int`	`VERSION_NUMBER_8_0` Constant value for version 8.0.0.
`static int`	`VERSION_NUMBER_8_0_1` Constant value for version 8.0.1.
`static int`	`VERSION_NUMBER_8_0_2` Constant value for version 8.0.2.
`static int`	`VERSION_NUMBER_8_1` Constant value for version 8.1.
`static int`	`VERSION_NUMBER_8_1_1` Constant value for version 8.1.
`static int`	`VERSION_NUMBER_8_5` Constant value for version 8.5.
`static int`	`VERSION_NUMBER_8_5_2` Constant value for version 8.5.2.
`static int`	`VERSION_NUMBER_8_6` Constant value for version 8.6.
`static int`	`VERSION_NUMBER_9_0` Constant value for version 9.0.
`static int`	`VERSION_NUMBER_9_0_1` Constant value for version 9.0.1.
`static int`	`VERSION_NUMBER_9_1` Constant value for version 9.1.
`static int`	`VERSION_NUMBER_9_2` Constant value for version 9.2.
`static int`	`VERSION_NUMBER_9_2_1` Constant value for version 9.2.1.
`static int`	`VERSION_NUMBER_9_2_2` Constant value for version 9.2.2.
`static int`	`VERSION_NUMBER_9_2_3` Constant value for version 9.2.3.
`static int`	`VERSION_NUMBER_9_2_4` Constant value for version 9.2.4.
`static int`	`VERSION_NUMBER_9_2_6` Constant value for version 9.2.6.
`static int`	`VERSION_NUMBER_9_2_7` Constant value for version 9.2.7.
`static int`	`WriteMetadataNever` Value of the catalog property for writing metadata back to an asset.
`static int`	`WriteMetadataSilent` Value of the catalog property for writing metadata back to an asset.
`static int`	`WriteMetadataWithUI` Value of the catalog property for writing metadata back to an asset.

Constructor Summary

Constructors
Constructor and Description

Cumulus()

Constructors
Constructor and Description
`Cumulus()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addStartStopListener(StartStopListener listener)` Adds a new `StartStopListener` to the Cumulus environment.
`static void`	`CumulusStart()` Initializes the Cumulus Java Classes.
`static void`	`CumulusStart(java.lang.String CumulusPath)` Initializes the Cumulus Java Classes to run a specific Cumulus Java Classes installation.
`static void`	`CumulusStop()` Terminates the Cumulus Java Classes.
`static java.lang.String`	`findToken(int id)` Returns a language-dependent token string using a language-independent ID.
`static java.lang.String`	`getInstallPath()` Returns the path name of the Cumulus Java Classes installation directory.
`static int`	`getLanguageID()` Returns the default language that is used for new sessions.
`static int`	`getTokenID(java.lang.String token)` Returns the language-independent ID for the given language-dependent token string.
`static java.lang.String`	`getVersion()` Returns the current version of this Cumulus Java Classes implementation as a `String`.
`static int`	`getVersionNumber()` Returns the current version number of this Cumulus Java Classes implementation as an `int`.
`static CumulusSession`	`newSession()` Create a new session to work with the Cumulus Java Classes.
`static void`	`removeStartStopListener(StartStopListener listener)` Removes a `StartStopListener` from the Cumulus environment.
`static void`	`requestGarbageCollection()` Request a memory optimization (garbage collection).
`static void`	`setAutomaticGarbageCollection(int objectsCreated)` Setup automatic call of the `System.gc()` and `System.runFinalization()` methods when the given number of Cumulus Java Classes objects are created.
`static void`	`setAutomaticGarbageCollectionInterval(int seconds)` Setup automatic call of the `System.gc()` and `System.runFinalization()` methods when the given time is elapsed.
`static void`	`setMaxTools(int maxTools)` Sets the maximum number of `CumulusTool` processes that can be started.
`static void`	`setToolTimeout(int milliseconds)` Sets the timeout (in milliseconds) that the Cumulus Java Classes waits for a CumulusTool processes to finish.

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

- Field Detail
  - VERSION_NUMBER_6_0
```
public static final int VERSION_NUMBER_6_0
```
    Constant value for version 6.0. This number can be compared to the return value of getVersionNumber().
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_7_0
```
public static final int VERSION_NUMBER_7_0
```
    Constant value for version 7.0. This number can be compared to the return value of getVersionNumber().
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_7_5
```
public static final int VERSION_NUMBER_7_5
```
    Constant value for version 7.5. This number can be compared to the return value of getVersionNumber().
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_7_5_3
```
public static final int VERSION_NUMBER_7_5_3
```
    Constant value for version 7.5.3. This number can be compared to the return value of getVersionNumber().
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_7_5_4
```
public static final int VERSION_NUMBER_7_5_4
```
    Constant value for version 7.5.4. This number can be compared to the return value of getVersionNumber().
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_7_6
```
public static final int VERSION_NUMBER_7_6
```
    Constant value for version 7.6. This number can be compared to the return value of getVersionNumber().
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_8_0
```
public static final int VERSION_NUMBER_8_0
```
    Constant value for version 8.0.0. This number can be compared to the return value of getVersionNumber().
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_8_0_1
```
public static final int VERSION_NUMBER_8_0_1
```
    Constant value for version 8.0.1. This number can be compared to the return value of getVersionNumber().
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_8_0_2
```
public static final int VERSION_NUMBER_8_0_2
```
    Constant value for version 8.0.2. This number can be compared to the return value of getVersionNumber().
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_8_1
```
public static final int VERSION_NUMBER_8_1
```
    Constant value for version 8.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    8.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_8_1_1
```
public static final int VERSION_NUMBER_8_1_1
```
    Constant value for version 8.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    8.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_8_5
```
public static final int VERSION_NUMBER_8_5
```
    Constant value for version 8.5. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    8.5
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_8_5_2
```
public static final int VERSION_NUMBER_8_5_2
```
    Constant value for version 8.5.2. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    8.5.2
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_8_6
```
public static final int VERSION_NUMBER_8_6
```
    Constant value for version 8.6. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    8.6
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_9_0
```
public static final int VERSION_NUMBER_9_0
```
    Constant value for version 9.0. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    9.0
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_9_0_1
```
public static final int VERSION_NUMBER_9_0_1
```
    Constant value for version 9.0.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    9.0.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_9_1
```
public static final int VERSION_NUMBER_9_1
```
    Constant value for version 9.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    9.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_9_2
```
public static final int VERSION_NUMBER_9_2
```
    Constant value for version 9.2. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    9.2
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_9_2_1
```
public static final int VERSION_NUMBER_9_2_1
```
    Constant value for version 9.2.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    9.2.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_9_2_2
```
public static final int VERSION_NUMBER_9_2_2
```
    Constant value for version 9.2.2. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    9.2.2
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_9_2_3
```
public static final int VERSION_NUMBER_9_2_3
```
    Constant value for version 9.2.3. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    9.2.3
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_9_2_4
```
public static final int VERSION_NUMBER_9_2_4
```
    Constant value for version 9.2.4. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    9.2.4
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_9_2_6
```
public static final int VERSION_NUMBER_9_2_6
```
    Constant value for version 9.2.6. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    9.2.6
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_9_2_7
```
public static final int VERSION_NUMBER_9_2_7
```
    Constant value for version 9.2.7. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    9.2.7
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_0
```
public static final int VERSION_NUMBER_10_0
```
    Constant value for version 10.0. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.0
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_0_1
```
public static final int VERSION_NUMBER_10_0_1
```
    Constant value for version 10.0.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.0.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_0_2
```
public static final int VERSION_NUMBER_10_0_2
```
    Constant value for version 10.0.2. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.0.2
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_0_3
```
public static final int VERSION_NUMBER_10_0_3
```
    Constant value for version 10.0.3. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.0.3
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_1
```
public static final int VERSION_NUMBER_10_1
```
    Constant value for version 10.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_1_1
```
public static final int VERSION_NUMBER_10_1_1
```
    Constant value for version 10.1.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.1.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_1_2
```
public static final int VERSION_NUMBER_10_1_2
```
    Constant value for version 10.1.2. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.1.2
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_1_3
```
public static final int VERSION_NUMBER_10_1_3
```
    Constant value for version 10.1.3. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.1.3
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_2
```
public static final int VERSION_NUMBER_10_2
```
    Constant value for version 10.2. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.2
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_2_1
```
public static final int VERSION_NUMBER_10_2_1
```
    Constant value for version 10.2.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.2.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_2_2
```
public static final int VERSION_NUMBER_10_2_2
```
    Constant value for version 10.2.2. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.2.2
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_2_3
```
public static final int VERSION_NUMBER_10_2_3
```
    Constant value for version 10.2.3. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.2.3
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_2_4
```
public static final int VERSION_NUMBER_10_2_4
```
    Constant value for version 10.2.4. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.2.4
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_2_5
```
public static final int VERSION_NUMBER_10_2_5
```
    Constant value for version 10.2.5. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.2.5
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_2_6
```
public static final int VERSION_NUMBER_10_2_6
```
    Constant value for version 10.2.6. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.2.6
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_10_2_7
```
public static final int VERSION_NUMBER_10_2_7
```
    Constant value for version 10.2.7. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    10.2.7
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_0
```
public static final int VERSION_NUMBER_11_0
```
    Constant value for version 11.0. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.0
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_0_1
```
public static final int VERSION_NUMBER_11_0_1
```
    Constant value for version 11.0.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.0.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_0_2
```
public static final int VERSION_NUMBER_11_0_2
```
    Constant value for version 11.0.2. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.0.2
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_0_3
```
public static final int VERSION_NUMBER_11_0_3
```
    Constant value for version 11.0.3. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.0.3
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_0_4
```
public static final int VERSION_NUMBER_11_0_4
```
    Constant value for version 11.0.4. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.0.4
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_1
```
public static final int VERSION_NUMBER_11_1
```
    Constant value for version 11.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_1_1
```
public static final int VERSION_NUMBER_11_1_1
```
    Constant value for version 11.1.1. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.1.1
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_1_2
```
public static final int VERSION_NUMBER_11_1_2
```
    Constant value for version 11.1.2. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.1.2
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_1_3
```
public static final int VERSION_NUMBER_11_1_3
```
    Constant value for version 11.1.3. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.1.3
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_1_4
```
public static final int VERSION_NUMBER_11_1_4
```
    Constant value for version 11.1.4. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.1.4
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_1_5
```
public static final int VERSION_NUMBER_11_1_5
```
    Constant value for version 11.1.5. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.1.5
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_1_6
```
public static final int VERSION_NUMBER_11_1_6
```
    Constant value for version 11.1.6. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.1.6
    
    See Also:
    Constant Field Values
  - VERSION_NUMBER_11_1_7
```
public static final int VERSION_NUMBER_11_1_7
```
    Constant value for version 11.1.7. This number can be compared to the return value of getVersionNumber().
    
    Since:
    
    11.1.7
    
    See Also:
    Constant Field Values
  - READ_WRITE_SERIAL_NUMBER
```
public static final java.lang.String READ_WRITE_SERIAL_NUMBER
```
    The Toolbox Runtime RW serial number to provide for read-write access in the Server.openConnection(boolean, String, String, String) connectToServer} method.
    
    See Also:
    Constant Field Values
  - READ_ONLY_SERIAL_NUMBER
```
public static final java.lang.String READ_ONLY_SERIAL_NUMBER
```
    The Toolbox Runtime RO serial number to provide for read-only access in the Server.openConnection(boolean, String, String, String) method.
    
    See Also:
    Constant Field Values
  - WriteMetadataNever
```
public static final int WriteMetadataNever
```
    Value of the catalog property for writing metadata back to an asset. This value means that Cumulus never writes back metadata.
    
    See Also:
    Constant Field Values
  - WriteMetadataSilent
```
public static final int WriteMetadataSilent
```
    Value of the catalog property for writing metadata back to an asset. This value means that Cumulus writes back metadata silently (without any user interface).
    
    See Also:
    Constant Field Values
  - WriteMetadataWithUI
```
public static final int WriteMetadataWithUI
```
    Value of the catalog property for writing metadata back to an asset. This value means that Cumulus writes back metadata including user interface.
    
    See Also:
    Constant Field Values
  - IndexKindNotIndexed
```
public static final int IndexKindNotIndexed
```
    Field index kind value for fields that are not indexed.
    
    See Also:
    FieldDefinition.getIndexing(), Constant Field Values
  - IndexKindSortIndexed
```
public static final int IndexKindSortIndexed
```
    Field index kind value for fields that are indexed for sorting only.
    
    See Also:
    FieldDefinition.getIndexing(), Constant Field Values
  - IndexKindContentIndexed
```
public static final int IndexKindContentIndexed
```
    Field index kind value for fields that are indexed for contain searching only.
    
    See Also:
    FieldDefinition.getIndexing(), Constant Field Values
  - IndexKindSortContentIndexed
```
public static final int IndexKindSortContentIndexed
```
    Field index kind value for fields that are indexed for sorting and contain searching.
    
    See Also:
    FieldDefinition.getIndexing(), Constant Field Values
  - IndexKindWordIndexed
```
public static final int IndexKindWordIndexed
```
    Field index kind value for fields that are word indexed.
    
    See Also:
    FieldDefinition.getIndexing(), Constant Field Values
  - IndexKindOptionalFlagWithoutWordBreak
```
public static final int IndexKindOptionalFlagWithoutWordBreak
```
    Field index kind flag for content indices without word break.
    
    Since:
    
    9.0
    
    See Also:
    FieldDefinition.getIndexing(), Constant Field Values
  - IndexKindOptionalFlagSegmentedIndex
```
public static final int IndexKindOptionalFlagSegmentedIndex
```
    Field index kind flag for segmented indices.
    
    Since:
    
    9.0
    
    See Also:
    FieldDefinition.getIndexing(), Constant Field Values
  - IndexKindOptionalFlagSolrIndex
```
public static final int IndexKindOptionalFlagSolrIndex
```
    Field index kind flag for Solr-based indices.
    
    Since:
    
    11.0
    
    See Also:
    FieldDefinition.getIndexing(), Constant Field Values
  - FindContains
```
public static final int FindContains
```
    Token ID for the "contains" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindStartsWith
```
public static final int FindStartsWith
```
    Token ID for the "starts with" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindIs
```
public static final int FindIs
```
    Token ID for the "is" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindIsNot
```
public static final int FindIsNot
```
    Token ID for the "is not" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindDoesntContain
```
public static final int FindDoesntContain
```
    Token ID for the "doesn't cont." find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindUnder
```
public static final int FindUnder
```
    Token ID for the "under" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindUpTo
```
public static final int FindUpTo
```
    Token ID for the "up to" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindFrom
```
public static final int FindFrom
```
    Token ID for the "from" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindOver
```
public static final int FindOver
```
    Token ID for the "over" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindPriorTo
```
public static final int FindPriorTo
```
    Token ID for the "prior to" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindAfter
```
public static final int FindAfter
```
    Token ID for the "after" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindThumbSimilar
```
public static final int FindThumbSimilar
```
    Token ID for the "similar to" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindThumbNotSimilar
```
public static final int FindThumbNotSimilar
```
    Token ID for the "not similar to" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindHasNoValue
```
public static final int FindHasNoValue
```
    Token ID for the "has no value to" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindHasValue
```
public static final int FindHasValue
```
    Token ID for the "has value to" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindBoolTrue
```
public static final int FindBoolTrue
```
    Token ID for the "true" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindBoolFalse
```
public static final int FindBoolFalse
```
    Token ID for the "false" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindAnd
```
public static final int FindAnd
```
    Token ID for the "and" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindOr
```
public static final int FindOr
```
    Token ID for the "or" find token.
    
    See Also:
    findToken(int), Constant Field Values
  - FindCategoriesField
```
public static final int FindCategoriesField
```
    Token ID for the "Categories" field name find token.
    
    See Also:
    findToken(int), Constant Field Values
  - TABLE_NAME_ASSET_RECORDS
```
public static final java.lang.String TABLE_NAME_ASSET_RECORDS
```
    See Also:
    Constant Field Values
  - TABLE_NAME_CATEGORIES
```
public static final java.lang.String TABLE_NAME_CATEGORIES
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Cumulus
```
public Cumulus()
```
- Method Detail
  - CumulusStart
```
public static void CumulusStart()
```
    Initializes the Cumulus Java Classes. This method must be called before any object of the Cumulus Java Classes is used. This method can be called multiple times but each call must be balanced with a corresponding CumulusStop(). The Cumulus installation directory will be determined from the System property "com.canto.cumulus.path" or from the location of the CumulusJC.jar file found in either the System property "java.class.path" or the CLASSPATH environment variable. If this fails the current directory is used.
  - CumulusStart
```
public static void CumulusStart(java.lang.String CumulusPath)
```
    Initializes the Cumulus Java Classes to run a specific Cumulus Java Classes installation. This method must be called before any object of the Cumulus Java Classes is used. This method can be called multiple times but each call must be balanced with a corresponding CumulusStop()
    
    Parameters:
    CumulusPath - the Cumulus Java Classes installation directory. If the parameter is null the Cumulus installation directory will be determined from the System property "com.canto.cumulus.path" or from the location of the CumulusJC.jar file found in either the System property "java.class.path" or the CLASSPATH environment variable. If this fails the current directory is used.
  - requestGarbageCollection
```
public static void requestGarbageCollection()
```
    Request a memory optimization (garbage collection). This only sets a flag but does not call System.gc() immediately.
    
    Since:
    
    7.5
  - getInstallPath
```
public static java.lang.String getInstallPath()
```
    Returns the path name of the Cumulus Java Classes installation directory.
    
    Returns:
    the path name of the Cumulus Java Classes installation directory.
  - newSession
```
public static CumulusSession newSession()
```
    Create a new session to work with the Cumulus Java Classes. A CumulusSession is the starting point of all Cumulus Java Classes.
    
    Returns:
    a new CumulusSession object.
  - CumulusStop
```
public static void CumulusStop()
```
    Terminates the Cumulus Java Classes. For multi-threaded use, all threads need to join before the last call to this method. This method complements a call to CumulusStart(). After the last call of this method you should not use any of the Cumulus Java Classes methods and objects anymore.
  - getLanguageID
```
public static int getLanguageID()
```
    Returns the default language that is used for new sessions.
    
    Returns:
    the default language ID
  - findToken
```
public static java.lang.String findToken(int id)
```
    Returns a language-dependent token string using a language-independent ID. In the following sample, the find request using the sQueryEnglish query string works only on a Cumulus installation with an english user interface. The second query string is language-independent because the findToken method returns the localized string. The localized field name is requested using the FieldDefinition object.
    For example:
```
 String sRecName = myCollection.getCatalog().getRecordLayout().getFieldDefinitions().getFieldDefinitionByID(GUID.UID_REC_RECORD_NAME).getName();

 // Only works with Cumulus english version
 String sQueryEnglish = "Record Name\tstarts with\tA";

 // Always works
 String sQuery = sRecName + "\t" + Cumulus.findToken(Cumulus.FindStartsWith) + "\t" + "A";
 
```
    Parameters:
    id - the token's ID. Possible values are:
    
    FindContains
    
    FindStartsWith
    
    FindIs
    
    FindIsNot
    
    FindDoesntContain
    
    FindUnder
    
    FindUpTo
    
    FindFrom
    
    FindOver
    
    FindThumbSimilar
    
    FindThumbNotSimilar
    
    FindHasNoValue
    
    FindHasValue
    
    FindBoolTrue
    
    FindBoolFalse
    
    FindAnd
    
    FindOr
    
    FindCategoriesField
    Returns:
    a language-dependent token string that can be used to build a query string.
  - getTokenID
```
public static int getTokenID(java.lang.String token)
```
    Returns the language-independent ID for the given language-dependent token string.
    
    Parameters:
    token - language-dependent token string
    
    Returns:
    language-independent ID or -1 if the token could not be resolved
  - getVersion
```
public static java.lang.String getVersion()
```
    Returns the current version of this Cumulus Java Classes implementation as a String.
    
    Returns:
    the current version of this Cumulus Java Classes.
  - addStartStopListener
```
public static void addStartStopListener(StartStopListener listener)
```
    Adds a new StartStopListener to the Cumulus environment. You can (and should) add this event listener before the first call to CumulusStart().
    
    Parameters:
    listener - a StartStopListener.
    Since:
    
    5.5.2
  - removeStartStopListener
```
public static void removeStartStopListener(StartStopListener listener)
```
    Removes a StartStopListener from the Cumulus environment.
    
    Parameters:
    listener - a StartStopListener.
    Since:
    
    5.5.2
  - setMaxTools
```
public static void setMaxTools(int maxTools)
```
    Sets the maximum number of CumulusTool processes that can be started. The Cumulus Java Classes use external CumulusTool processes to perform cataloging, updating and converting tasks. It starts a new CumulusTool when it can not find a running inactive process for the same server, user name, and catalog. Default is 10, minimum is 1, maximum is 1000.
    
    Parameters:
    maxTools - the maximum number of CumulusTool processes that can be started.
    Since:
    
    6.0.1
  - setToolTimeout
```
public static void setToolTimeout(int milliseconds)
```
    Sets the timeout (in milliseconds) that the Cumulus Java Classes waits for a CumulusTool processes to finish. Default is 2 minutes (120,000 ms), minimum is 1 second (1,000 ms), maximum is 1 hour (3,600,000 ms).
    
    Parameters:
    milliseconds - the timeout in milliseconds.
    Since:
    
    6.0.1
  - setAutomaticGarbageCollection
```
public static void setAutomaticGarbageCollection(int objectsCreated)
```
    Setup automatic call of the System.gc() and System.runFinalization() methods when the given number of Cumulus Java Classes objects are created. When the trigger value is reached the Cumulus Java Classes automatically trigger the Java garbage collector for the next time interval and reset the internal counter. The Cumulus Java Classes library starts up with a value of 10000 which seems to be the optimum for smooth operation.
    
    Parameters:
    objectsCreated - the number of Cumulus Java Classes objects created before garbage collection is done. A value of 0 switches off automatic garbage collection on object creation.
  - setAutomaticGarbageCollectionInterval
```
public static void setAutomaticGarbageCollectionInterval(int seconds)
```
    Setup automatic call of the System.gc() and System.runFinalization() methods when the given time is elapsed. The time is given in seconds. The Cumulus Java Classes library starts up with a value of 60 seconds which seems to be the optimum for smooth operation.
    
    Parameters:
    seconds - the number of seconds between two automatic garbage collections. A value of 0 switches off automatic garbage collection.
    Since:
    
    7.5
  - getVersionNumber
```
public static int getVersionNumber()
```
    Returns the current version number of this Cumulus Java Classes implementation as an int. The highest byte contains the major version while the others contain the minor, bug fix and build version respectively. You can check whether the Cumulus Java Classes are at least version 7.5.1 by testing whether this value is >= 0x07050100. You can also use the following version constants (e.g. VERSION_NUMBER_7_5).
    
    Returns:
    the current version of this Cumulus Java Classes.

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class Cumulus

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION_NUMBER_6_0

VERSION_NUMBER_7_0

VERSION_NUMBER_7_5

VERSION_NUMBER_7_5_3

VERSION_NUMBER_7_5_4

VERSION_NUMBER_7_6

VERSION_NUMBER_8_0

VERSION_NUMBER_8_0_1

VERSION_NUMBER_8_0_2

VERSION_NUMBER_8_1

VERSION_NUMBER_8_1_1

VERSION_NUMBER_8_5

VERSION_NUMBER_8_5_2

VERSION_NUMBER_8_6

VERSION_NUMBER_9_0

VERSION_NUMBER_9_0_1

VERSION_NUMBER_9_1

VERSION_NUMBER_9_2

VERSION_NUMBER_9_2_1

VERSION_NUMBER_9_2_2

VERSION_NUMBER_9_2_3

VERSION_NUMBER_9_2_4

VERSION_NUMBER_9_2_6

VERSION_NUMBER_9_2_7

VERSION_NUMBER_10_0

VERSION_NUMBER_10_0_1

VERSION_NUMBER_10_0_2

VERSION_NUMBER_10_0_3

VERSION_NUMBER_10_1

VERSION_NUMBER_10_1_1

VERSION_NUMBER_10_1_2

VERSION_NUMBER_10_1_3

VERSION_NUMBER_10_2

VERSION_NUMBER_10_2_1

VERSION_NUMBER_10_2_2

VERSION_NUMBER_10_2_3

VERSION_NUMBER_10_2_4

VERSION_NUMBER_10_2_5

VERSION_NUMBER_10_2_6

VERSION_NUMBER_10_2_7

VERSION_NUMBER_11_0

VERSION_NUMBER_11_0_1

VERSION_NUMBER_11_0_2

VERSION_NUMBER_11_0_3

VERSION_NUMBER_11_0_4

VERSION_NUMBER_11_1

VERSION_NUMBER_11_1_1

VERSION_NUMBER_11_1_2

VERSION_NUMBER_11_1_3

VERSION_NUMBER_11_1_4

VERSION_NUMBER_11_1_5

VERSION_NUMBER_11_1_6

VERSION_NUMBER_11_1_7

READ_WRITE_SERIAL_NUMBER

READ_ONLY_SERIAL_NUMBER

WriteMetadataNever

WriteMetadataSilent

WriteMetadataWithUI

IndexKindNotIndexed

IndexKindSortIndexed

IndexKindContentIndexed

IndexKindSortContentIndexed

IndexKindWordIndexed

IndexKindOptionalFlagWithoutWordBreak

IndexKindOptionalFlagSegmentedIndex

IndexKindOptionalFlagSolrIndex

FindContains

FindStartsWith

FindIs

FindIsNot

FindDoesntContain

FindUnder

FindUpTo

FindFrom