Catalog (Cumulus Java Classes Documentation)

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

```
public final class Catalog
extends java.lang.Object
```
The Catalog object allows you to access the properties of an open Cumulus catalog.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Catalog.CatalogInfo
This class hold the information for a Catalog.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Catalog.CatalogInfo` This class hold the information for a `Catalog`.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`STATISTICS_CATALOG_NAME` Name of the statistics catalog.
`static java.lang.String`	`USERS_CATALOG_NAME` Name of the users catalog.
`static java.lang.String`	`VOCABULARIES_CATALOG_NAME` Name of the vocabularies catalog.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCatalogPropertiesListener(CatalogPropertiesListener<Catalog> listener)` Add a listener that is called whenever the properties of a catalog have changed.
`static void`	`addGlobalCatalogPropertiesListener(CatalogPropertiesListener<Catalog> listener)` Add a listener that is called whenever the properties of a catalog have changed.
`void`	`backup(java.lang.String pathName)` Stores a backup copy of the catalog in the given file (Specific Permissions Required).
`void`	`backup(java.lang.String pathName, ProgressListener progressListener)` Stores a backup copy of the catalog in the given file (Specific Permissions Required).
`void`	`compress()` Compresses the catalog (Administrator only).
`void`	`compress(ProgressListener progressListener)` Compresses the catalog (Administrator only).
`boolean`	`equals(java.lang.Object o)`
`AllCategoriesItemCollection`	`getAllCategoriesItemCollection()` Returns a collection that always contains all categories that the current user is allowed to see.
`ItemCollection`	`getAllVocabulariesItemCollection()` Returns an `ItemCollection` containing all items of the $Vocabulary catalog.
`Catalog.CatalogInfo`	`getCatalogInfo()` Get information about this catalog.
`JPack`	`getCatalogReference()` Returns the catalog reference package for this catalog.
`CentralAssetLocationMode`	`getCentralAssetLocationMode()` Returns the current central asset location mode.
`AssetReference`	`getCentralAssetLocationReference()`
`java.lang.String`	`getCentralAssetLocationXML()` Returns the central asset location reference as XML.
`CumulusSession`	`getCumulusSession()` Returns the current `CumulusSession` object.
`java.lang.String`	`getDescription()` Returns the catalog's description or null if not configured.
`java.lang.String`	`getDescription(int languageID)` Returns the catalog's description or null if not configured.
`java.lang.String`	`getDisplayName()` Returns the catalog's display name or the catalogs name if not configured.
`java.lang.String`	`getDisplayName(int languageID)` Returns the catalog's display name or the catalogs name if not configured.
`int`	`getID()` Returns the catalog's unique ID.
`boolean`	`getIsReadOnly()` Returns whether the catalog is physically read-only.
`boolean`	`getIsRemoteCatalog()` Returns if the catalog is opened as a client.
`Layout`	`getLayout(java.lang.String tableName)` Get the layout for a given table.
`java.lang.String`	`getLocation()` Returns the catalog's location.
`java.lang.String`	`getName()` Returns the catalog's name.
`java.lang.Object`	`getParent()` Returns the parent object of this catalog.
`CatalogSettingsRoot`	`getProperties()` Returns the catalog properties.
`Server`	`getServer()` Get the `Server` object that created this catalog object.
`JPack`	`getStatistics()` Returns a pack that contains some statistics about this catalog.
`CatalogWorkflowList`	`getWorkflows()` Returns the configured workflows for this catalog.
`int`	`hashCode()`
`boolean`	`hasTable(java.lang.String tableName)` Returns whether this catalog offers the table with the given name.
`boolean`	`keepCategoryNamesUnique()` Returns whether the catalog keep category names unique.
`void`	`migrate()` Migrates the catalog to the latest catalog format.
`static void`	`migrate(java.io.File srcCatalogFile, java.io.File migratedCatalogFile)` Migrated the given local catalog file to the latest version.
`static void`	`migrate(java.io.File srcCatalogFile, java.io.File migratedCatalogFile, ProgressListener progressListener)` Migrated the given local catalog file to the latest version.
`void`	`migrate(ProgressListener progressListener)` Migrates the catalog to the latest catalog format.
`CategoryItemCollection`	`newCategoryItemCollection()` Create a new `CategoryItemCollection` and containing all categories that are accessible to the current user.
`CategoryItemCollection`	`newCategoryItemCollection(java.lang.String masterCategory)` Create a new `CategoryItemCollection` and containing all categories of the given master category that are accessible to the current user.
`CategoryItemCollection`	`newCategoryItemCollection(java.lang.String masterCategory, java.lang.String query, java.util.Locale locale)` Create a new `CategoryItemCollection` and containing all categories of the given master category that match a given query and are accessible to the current user.
`ItemCollection`	`newItemCollection(java.lang.String tableName, boolean findAllItems)` Create a new `ItemCollection` for the given table and optionally fill in all items that are accessible to the current user.
`ItemCollection`	`newItemCollection(java.lang.String tableName, java.lang.String query, java.util.EnumSet<FindFlag> flags, java.util.Locale locale)` Returns a newly created collection that is filled by executing the given query.
`RecordItemCollection`	`newRecordItemCollection(boolean findAll)` Create a new `RecordItemCollection` and optionally fill in all items that are accessible to the current user.
`RecordItemCollection`	`newRecordItemCollection(java.lang.String query, java.util.Locale locale)` Create a new `RecordItemCollection` and fill it with the record items found by the given query.
`void`	`rebuild()` Repairs the catalog and rebuilds the indices (Administrator only).
`void`	`rebuild(boolean useMirroringConfiguration)` Rebuilds the catalog.
`void`	`rebuild(boolean useMirroringConfiguration, ProgressListener progressListener)` Rebuilds the catalog.
`void`	`removeCatalogProperties(CatalogPropertiesListener<Catalog> listener)` Remove a listener previously added with the call to `addCatalogPropertiesListener(com.canto.cumulus.events.CatalogPropertiesListener)`
`static void`	`removeGlobalCatalogPropertiesListener(CatalogPropertiesListener<Catalog> listener)` Remove a listener previously added using `addGlobalCatalogPropertiesListener(com.canto.cumulus.events.CatalogPropertiesListener)`.
`byte[]`	`sendMessage(java.lang.String module, byte[] inData)` Sends a message with parameters to a server plug-in module.
`java.lang.String`	`sendMessage(java.lang.String module, java.lang.String msg)` Sends a message to a server plug-in module (Administrator only).
`java.lang.String`	`sendMessage(java.lang.String module, java.lang.String msg, java.lang.String params)` Sends a message with parameters to a server plug-in module (Administrator only).
`java.lang.String`	`toString()` Returns the catalog's name.
`java.lang.String`	`validateTable(java.lang.String tableName)` Validates the given table data and returns an error message.

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

- Field Detail
  - USERS_CATALOG_NAME
```
public static final java.lang.String USERS_CATALOG_NAME
```
    Name of the users catalog.
    
    Since:
    
    10.0.2
    
    See Also:
    Constant Field Values
  - STATISTICS_CATALOG_NAME
```
public static final java.lang.String STATISTICS_CATALOG_NAME
```
    Name of the statistics catalog.
    
    Since:
    
    10.0.2
    
    See Also:
    Constant Field Values
  - VOCABULARIES_CATALOG_NAME
```
public static final java.lang.String VOCABULARIES_CATALOG_NAME
```
    Name of the vocabularies catalog.
    
    Since:
    
    10.0.2
    
    See Also:
    Constant Field Values
- Method Detail
  - getCumulusSession
```
public CumulusSession getCumulusSession()
```
    Returns the current CumulusSession object.
    
    Returns:
    the current CumulusSession object.
  - getIsRemoteCatalog
```
public boolean getIsRemoteCatalog()
```
    Returns if the catalog is opened as a client. Here only remote catalogs are supported.
    
    Returns:
    true if the catalog is a remote catalog; false otherwise.
  - getServer
```
public Server getServer()
```
    Get the Server object that created this catalog object.
    
    Returns:
    The server that was used to open this catalog.
    Since:
    
    8.0
  - getID
```
public int getID()
```
    Returns the catalog's unique ID. This ID is valid until the catalog is closed. If the same catalog is reopened, it will have another ID.
    
    Returns:
    the catalog's unique ID.
  - getName
```
public java.lang.String getName()
```
    Returns the catalog's name.
    
    Returns:
    the catalog's name.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Returns the catalog's display name or the catalogs name if not configured.
    
    Returns:
    the catalog's name or null if not configured
    Since:
    
    8.5
  - getDisplayName
```
public java.lang.String getDisplayName(int languageID)
```
    Returns the catalog's display name or the catalogs name if not configured.
    
    Parameters:
    languageID - language to get the display name for
    
    Returns:
    the catalog's name or null if not configured
    Since:
    
    8.5
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the catalog's description or null if not configured.
    
    Returns:
    the catalog's description or null if not configured
    Since:
    
    8.5
  - getDescription
```
public java.lang.String getDescription(int languageID)
```
    Returns the catalog's description or null if not configured.
    
    Parameters:
    languageID - language to get the description for
    
    Returns:
    the catalog's description or null if not configured
    Since:
    
    8.5
  - getLocation
```
public java.lang.String getLocation()
```
    Returns the catalog's location.
    
    Returns:
    the catalog's location.
  - getCatalogReference
```
public JPack getCatalogReference()
```
    Returns the catalog reference package for this catalog. The returned reference package can be used to later find the catalog at the server.
    
    Returns:
    the catalog reference as a package.
    See Also:
    Server.findCatalogID(com.canto.cumulus.utils.JPack)
  - newItemCollection
```
public ItemCollection newItemCollection(java.lang.String tableName,
                               boolean findAllItems)
                                 throws CumulusException
```
    Create a new ItemCollection for the given table and optionally fill in all items that are accessible to the current user.
    
    Parameters:
    tableName - The name of the table in the catalog. You can pass one the predefined table names Cumulus.TABLE_NAME_ASSET_RECORDS or Cumulus.TABLE_NAME_CATEGORIES or the name of the table for a table field in one of these tables. In case this method is called for the Cumulus.TABLE_NAME_ASSET_RECORDS table it returns an instance of the sub-class RecordItemCollection. In case this method is called for the Cumulus.TABLE_NAME_ASSET_RECORDS table it returns an instance of the sub-class CategoryItemCollection.
    findAllItems - A boolean specifying whether to fill in all accessible items.
    
    Returns:
    A newly created ItemCollection
    
    Throws:
    
    CumulusException - on error (e.g. wrong table name)
    Since:
    
    8.0
    
    See Also:
    newRecordItemCollection(boolean), newCategoryItemCollection(), newCategoryItemCollection(String)
  - newRecordItemCollection
```
public RecordItemCollection newRecordItemCollection(java.lang.String query,
                                           java.util.Locale locale)
                                             throws QueryParserException,
                                                    InvalidArgumentException,
                                                    CumulusException
```
    Create a new RecordItemCollection and fill it with the record items found by the given query.
    
    Parameters:
    query - The query string to execute to fill in the collection. An empty or null string returns an empty collection.
    locale - The locale to use for parsing the query string
    
    Returns:
    A newly created RecordItemCollection
    
    Throws:
    
    InvalidArgumentException - on error finding values specified in the query string
    
    CumulusException - on other errors
    
    QueryParserException - on errors parsing the query string
    Since:
    
    8.0
    
    See Also:
    newRecordItemCollection(boolean)
  - newRecordItemCollection
```
public RecordItemCollection newRecordItemCollection(boolean findAll)
```
    Create a new RecordItemCollection and optionally fill in all items that are accessible to the current user.
    
    Parameters:
    findAll - A boolean specifying whether to fill in all accessible items.
    
    Returns:
    A newly created RecordItemCollection
    Since:
    
    8.0
  - newCategoryItemCollection
```
public CategoryItemCollection newCategoryItemCollection()
```
    Create a new CategoryItemCollection and containing all categories that are accessible to the current user.
    
    Returns:
    A newly created CategoryItemCollection
    Since:
    
    8.0
  - newCategoryItemCollection
```
public CategoryItemCollection newCategoryItemCollection(java.lang.String masterCategory)
                                                 throws InvalidArgumentException,
                                                        CumulusException
```
    Create a new CategoryItemCollection and containing all categories of the given master category that are accessible to the current user.
    
    Parameters:
    masterCategory - The name of the master category for limiting the categories returned in the collection. The master category name is the name of one of the available categories of type CategoryType.MASTER e.g. "$Source".
    
    Returns:
    A newly created CategoryItemCollection
    
    Throws:
    
    InvalidArgumentException - in case the master category does not exist
    
    CumulusException - on other errors
    Since:
    
    8.0
  - newCategoryItemCollection
```
public CategoryItemCollection newCategoryItemCollection(java.lang.String masterCategory,
                                               java.lang.String query,
                                               java.util.Locale locale)
                                                 throws InvalidArgumentException,
                                                        CumulusException
```
    Create a new CategoryItemCollection and containing all categories of the given master category that match a given query and are accessible to the current user.
    
    Parameters:
    masterCategory - The name of the master category for limiting the categories returned in the collection. The master category name is the name of one of the available categories of type CategoryType.MASTER e.g. "$Source".
    query - The query string to execute to fill in the collection. An empty or null string returns an empty collection.
    locale - The locale to use for parsing the query string
    
    Returns:
    A newly created CategoryItemCollection
    
    Throws:
    
    InvalidArgumentException - in case the master category does not exist
    
    CumulusException - on other errors
    Since:
    
    9.0
  - getProperties
```
public CatalogSettingsRoot getProperties()
```
    Returns the catalog properties.
    
    Returns:
    the catalog properties.
  - getStatistics
```
public JPack getStatistics()
```
    Returns a pack that contains some statistics about this catalog. This method is unstable and WILL change in the future.
    
    Returns:
    statistics pack
    Since:
    
    8.6
  - getWorkflows
```
public CatalogWorkflowList getWorkflows()
```
    Returns the configured workflows for this catalog.
    
    Returns:
    configured workflows for this catalog
    Since:
    
    9.2
  - getParent
```
public java.lang.Object getParent()
```
    Returns the parent object of this catalog.
    
    Returns:
    the Server to which this catalog belongs for remote catalogs or the CumulusSession for local catalogs.
    Since:
    
    6.0
  - getIsReadOnly
```
public boolean getIsReadOnly()
```
    Returns whether the catalog is physically read-only. A catalog is read-only if, for example, the "Catalog.ccf" file is read-only.
    
    Returns:
    true if the catalog is physically read-only; false otherwise.
  - getCentralAssetLocationReference
```
public AssetReference getCentralAssetLocationReference()
```
    Returns:
    the AssetReference object holding the reference to the central asset location if defined for this catalog. Before accessing this asset reference you should check that it is used by calling getCentralAssetLocationMode().
    Since:
    
    8.0
  - getCentralAssetLocationXML
```
public java.lang.String getCentralAssetLocationXML()
                                            throws CumulusException
```
    Returns the central asset location reference as XML.
    
    Returns:
    the central asset location reference as XML.
    
    Throws:
    
    CumulusException - if no central asset location is defined.
  - getCentralAssetLocationMode
```
public CentralAssetLocationMode getCentralAssetLocationMode()
```
    Returns the current central asset location mode.
    
    Returns:
    the current central asset location usage value
    Since:
    
    8.0
    
    See Also:
    CentralAssetLocationMode
  - getLayout
```
public Layout getLayout(java.lang.String tableName)
                 throws CumulusException
```
    Get the layout for a given table.
    
    Parameters:
    tableName - The name of the table in the catalog. You can pass one the predefined table names Cumulus.TABLE_NAME_ASSET_RECORDS or Cumulus.TABLE_NAME_CATEGORIES or the name of the table for a table field in one of these tables. To get the table name of a specific field you can call FieldDefinition.getValueTableName() or CatalogField.getTableName().
    
    Returns:
    The Layout object
    
    Throws:
    
    CumulusException - on error (e.g. table name is invalid)
    Since:
    
    8.0
  - hasTable
```
public boolean hasTable(java.lang.String tableName)
```
    Returns whether this catalog offers the table with the given name.
    
    Parameters:
    tableName - table name to check for
    
    Returns:
    true if a table with that name exists in this catalog
    Since:
    
    8.5
  - sendMessage
```
public java.lang.String sendMessage(java.lang.String module,
                           java.lang.String msg)
                             throws CumulusException
```
    Sends a message to a server plug-in module (Administrator only). See the documentation of the corresponding server module for a description of the messages, parameters and reply strings.
    
    Parameters:
    module - the name or unique ID of the server module.
    msg - the message string.
    
    Returns:
    the server module reply.
    
    Throws:
    
    CumulusException - is the message cannot be sent.
  - sendMessage
```
public java.lang.String sendMessage(java.lang.String module,
                           java.lang.String msg,
                           java.lang.String params)
                             throws CumulusException
```
    Sends a message with parameters to a server plug-in module (Administrator only). See the documentation of the corresponding server module for a description of the messages, parameters and reply strings.
    
    Parameters:
    module - the name or unique ID of the server module.
    msg - the message string.
    params - the parameters.
    
    Returns:
    the server module reply.
    
    Throws:
    
    CumulusException - is the message cannot be sent.
  - sendMessage
```
public byte[] sendMessage(java.lang.String module,
                 byte[] inData)
                   throws CumulusException
```
    Sends a message with parameters to a server plug-in module. See the documentation of the corresponding server module for a description of the messages and reply data.
    
    Parameters:
    module - the name or unique ID of the server module.
    inData - the message data to send to the module.
    
    Returns:
    the server module reply data.
    
    Throws:
    
    CumulusException - if the message cannot be sent.
    Since:
    
    6.6
  - getCatalogInfo
```
public Catalog.CatalogInfo getCatalogInfo()
```
    Get information about this catalog.
    
    Returns:
    Catalog information
    Since:
    
    8.0
  - rebuild
```
public void rebuild()
             throws CumulusException
```
    Repairs the catalog and rebuilds the indices (Administrator only).
    
    Throws:
    
    CumulusException - if the catalog cannot be repaired.
  - rebuild
```
public void rebuild(boolean useMirroringConfiguration)
             throws CumulusException
```
    Rebuilds the catalog.
    
    Parameters:
    useMirroringConfiguration - if this is true the server tries to use the mirroring information which might fail if that information cannot be read otherwise always tries a local rebuild.
    
    Throws:
    
    CumulusException - in case of an error while rebuilding
    Since:
    
    8.0
  - rebuild
```
public void rebuild(boolean useMirroringConfiguration,
           ProgressListener progressListener)
             throws CumulusException
```
    Rebuilds the catalog.
    
    Parameters:
    useMirroringConfiguration - if this is true the server tries to use the mirroring information which might fail if that information cannot be read otherwise always tries a local rebuild.
    progressListener - a listener which gets some progress information
    
    Throws:
    
    CumulusException - in case of an error while rebuilding
    Since:
    
    9.2
  - migrate
```
public void migrate()
             throws CumulusException
```
    Migrates the catalog to the latest catalog format. This might take a long time to complete.
    
    Throws:
    
    CumulusException - in case of an error while migrating
    Since:
    
    8.6.1
  - migrate
```
public void migrate(ProgressListener progressListener)
             throws CumulusException
```
    Migrates the catalog to the latest catalog format. This might take a long time to complete.
    
    Parameters:
    progressListener - a listener which gets some progress information
    
    Throws:
    
    CumulusException - in case of an error while migrating
    Since:
    
    9.2
  - migrate
```
public static void migrate(java.io.File srcCatalogFile,
           java.io.File migratedCatalogFile)
                    throws CumulusException,
                           java.io.IOException
```
    Migrated the given local catalog file to the latest version. This migration copies all data into a new catalog file and does not change the source catalog.
    
    Parameters:
    srcCatalogFile - catalog file to migrate
    migratedCatalogFile - contains resulting catalog and must not exist when calling this method
    
    Throws:
    
    java.io.IOException - in case the given input file cannot be resolved or accessed
    
    CumulusException - in case of an error
    Since:
    
    9.2
  - migrate
```
public static void migrate(java.io.File srcCatalogFile,
           java.io.File migratedCatalogFile,
           ProgressListener progressListener)
                    throws CumulusException,
                           java.io.IOException
```
    Migrated the given local catalog file to the latest version. This migration copies all data into a new catalog file and does not change the source catalog.
    
    Parameters:
    srcCatalogFile - catalog file to migrate
    migratedCatalogFile - contains resulting catalog and must not exist when calling this method
    progressListener - a listener which gets some progress information
    
    Throws:
    
    java.io.IOException - in case the given input file cannot be resolved or accessed
    
    CumulusException - in case of an error
    Since:
    
    9.1
  - compress
```
public void compress(ProgressListener progressListener)
              throws CumulusException
```
    Compresses the catalog (Administrator only).
    
    Parameters:
    progressListener - a listener which gets some progress information
    
    Throws:
    
    CumulusException - on error
    Since:
    
    9.2
  - compress
```
public void compress()
              throws CumulusException
```
    Compresses the catalog (Administrator only).
    
    Throws:
    
    CumulusException - on error
  - backup
```
public void backup(java.lang.String pathName)
            throws CumulusException
```
    Stores a backup copy of the catalog in the given file (Specific Permissions Required).
    Required Permissions are:
    - PredefinedPermissions.SERVER_PERMISSION_BACKUP_ADMIN
    The catalog file will be copied completely and can be used as a regular catalog. Compressed backup catalogs are not supported anymore.
    Parameters:
    pathName - the backup copy's path name.
    
    Throws:
    
    CumulusException - if the catalog cannot be saved.
  - backup
```
public void backup(java.lang.String pathName,
          ProgressListener progressListener)
            throws CumulusException
```
    Stores a backup copy of the catalog in the given file (Specific Permissions Required).
    Required Permissions are:
    - PredefinedPermissions.SERVER_PERMISSION_BACKUP_ADMIN
    The catalog file will be copied completely and can be used as a regular catalog. Compressed backup catalogs are not supported anymore.
    Parameters:
    pathName - the backup copy's path name.
    progressListener - a listener which gets some progress information
    
    Throws:
    
    CumulusException - if the catalog cannot be saved.
    Since:
    
    9.2
  - validateTable
```
public java.lang.String validateTable(java.lang.String tableName)
```
    Validates the given table data and returns an error message. Unstable API! Do not use.
    
    Parameters:
    tableName - name of the table to validate
    
    Returns:
    error message describing found problems in the specified table
    Since:
    
    9.1
  - toString
```
public java.lang.String toString()
```
    Returns the catalog's name.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the catalog's name.
    See Also:
    getName()
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getAllCategoriesItemCollection
```
public AllCategoriesItemCollection getAllCategoriesItemCollection()
```
    Returns a collection that always contains all categories that the current user is allowed to see. This collection should be used for checking whether a specific category is available. It can not be modified.
    
    Returns:
    The collection containing all categories.
    Since:
    
    8.0
    
    See Also:
    newCategoryItemCollection()
  - getAllVocabulariesItemCollection
```
public ItemCollection getAllVocabulariesItemCollection()
```
    Returns an ItemCollection containing all items of the $Vocabulary catalog. This collection can't be used to search for items. Instead it can be used to access all vocabulary items.
    
    Returns:
    ItemCollection containing all items of the $Vocabulary catalog
    Since:
    
    10.0.2
  - keepCategoryNamesUnique
```
public boolean keepCategoryNamesUnique()
```
    Returns whether the catalog keep category names unique.
    
    Returns:
    true if category names should be unique; false otherwise
    Since:
    
    10.2
  - newItemCollection
```
public ItemCollection newItemCollection(java.lang.String tableName,
                               java.lang.String query,
                               java.util.EnumSet<FindFlag> flags,
                               java.util.Locale locale)
                                 throws QueryParserException,
                                        CumulusException
```
    Returns a newly created collection that is filled by executing the given query.
    
    Parameters:
    tableName - the name of the table to create a collection for. This is either Cumulus.TABLE_NAME_ASSET_RECORDS, Cumulus.TABLE_NAME_CATEGORIES or a name of a table field's sub-table that is returned by FieldDefinition.getValueTableName().
    query - the query to execute to fill the collection with items. A null or empty query will create an empty collection.
    flags - query parsing flags, see FindFlag.
    locale - The locale to use for parsing the query string
    
    Returns:
    The collection containing all categories.
    
    Throws:
    
    QueryParserException - on errors parsing the query string
    
    CumulusException - on other errors
    Since:
    
    8.0
    
    See Also:
    ItemCollection.find(String, java.util.EnumSet, com.canto.cumulus.constants.CombineMode, java.util.Locale), newItemCollection(String, boolean)
  - addCatalogPropertiesListener
```
public void addCatalogPropertiesListener(CatalogPropertiesListener<Catalog> listener)
```
    Add a listener that is called whenever the properties of a catalog have changed. This method adds a listener to a specific Catalog. If you are interested in changes in any of the Catalog objects use addGlobalCatalogPropertiesListener(com.canto.cumulus.events.CatalogPropertiesListener) instead. Call removeCatalogProperties(com.canto.cumulus.events.CatalogPropertiesListener) to remove this listener from the collection.
    
    Parameters:
    listener - The listener to add.
    Since:
    
    9.2
    
    See Also:
    removeCatalogProperties(com.canto.cumulus.events.CatalogPropertiesListener), addGlobalCatalogPropertiesListener(com.canto.cumulus.events.CatalogPropertiesListener)
  - removeCatalogProperties
```
public void removeCatalogProperties(CatalogPropertiesListener<Catalog> listener)
```
    Remove a listener previously added with the call to addCatalogPropertiesListener(com.canto.cumulus.events.CatalogPropertiesListener)
    
    Parameters:
    listener - The listener to remove.
    Since:
    
    9.2
    
    See Also:
    addCatalogPropertiesListener(com.canto.cumulus.events.CatalogPropertiesListener)
  - addGlobalCatalogPropertiesListener
```
public static void addGlobalCatalogPropertiesListener(CatalogPropertiesListener<Catalog> listener)
```
    Add a listener that is called whenever the properties of a catalog have changed. If you are interested in a specific Catalog you should use addCatalogPropertiesListener(com.canto.cumulus.events.CatalogPropertiesListener) instead. Call removeGlobalCatalogPropertiesListener(com.canto.cumulus.events.CatalogPropertiesListener) to remove this global listener from the Catalog class.
    
    Parameters:
    listener - The listener to add globally.
    Since:
    
    9.2
  - removeGlobalCatalogPropertiesListener
```
public static void removeGlobalCatalogPropertiesListener(CatalogPropertiesListener<Catalog> listener)
```
    Remove a listener previously added using addGlobalCatalogPropertiesListener(com.canto.cumulus.events.CatalogPropertiesListener).
    
    Parameters:
    listener - The listener to remove.
    Since:
    
    9.2

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 Catalog

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USERS_CATALOG_NAME

STATISTICS_CATALOG_NAME

VOCABULARIES_CATALOG_NAME

Method Detail

getCumulusSession

getIsRemoteCatalog

getServer

getID

getName

getDisplayName

getDisplayName

getDescription

getDescription

getLocation

getCatalogReference

newItemCollection

newRecordItemCollection

newRecordItemCollection

newCategoryItemCollection

newCategoryItemCollection

newCategoryItemCollection

getProperties

getStatistics

getWorkflows

getParent

getIsReadOnly

getCentralAssetLocationReference

getCentralAssetLocationXML

getCentralAssetLocationMode

getLayout

hasTable

sendMessage

sendMessage

sendMessage

getCatalogInfo

rebuild

rebuild

rebuild

migrate

migrate

migrate

migrate

compress

compress

backup

backup

validateTable

toString

equals

hashCode

getAllCategoriesItemCollection

getAllVocabulariesItemCollection

keepCategoryNamesUnique

newItemCollection

addCatalogPropertiesListener

removeCatalogProperties

addGlobalCatalogPropertiesListener

removeGlobalCatalogPropertiesListener