Skip to main content

Core API

Description​

This entry provides a collection of utility methods which could be added to a project as a dependency. It allows you to quickly get started with development.

Note:
This is a JAR library that is included as an internal library of the .war plugin when building, located under WEB-INF/lib.

Features​

The following table summarizes the available utility classes:

Utility Classes Overview​

ClassDescription
CoreCommonUtilsGeneric utility class.
CoreConfigUtilsLoads XML configuration as JSON.
CoreContextUtilsUtilities for working with context entity objects.
CoreEntityUtilsUtilities for entity handling.
CoreLogUtilsLogs entity objects or lists of objects.
CorePlanningUtilsMethods for document, publication, and parameter handling.
CoreTaggedTextUtilsCreate character styles, paragraph styles, and inline tagged text.
CoreXpathUtilsMethods for XPath handling.
CoreTableUtilsMethods for creating table cells and rows.
CoreTocUtilsUtilities for working with CometTocEntry.
CoreExcelUtilsMethods for reading Excel and CSV files.
CoreBasicComparatorCompare integers, floats, and strings (used for list sorting).
CoreObjectComparatorComparator for sorting objects (extends basic comparator logic).
CoreDocumentUtilsUtility methods for working with document objects.
CorePublicationUtilsUtility methods for publication objects.
CoreTemplateUtilsUtility methods for template and page template objects.
CoreWorkflowUtilsUtility methods for workflow processing.

The Core API is not distributed as a deployment package. It is a JAR library that is compiled into the plugins that depend on it.