Page tree
Skip to end of metadata
Go to start of metadata


The AIE Java Model API contains classes that represent the data model used inside the Attivio server and between Attivio and client applications. It supports both the Java Server API and the Java Client API, providing essential classes such as IngestDocument, ContentPointer, AttivioException, and TokenList


View incoming links.

Java Model API Overview

The Java Model API draws on classes and interfaces from the following AIE packages:



Contains exception classes, such as AttivioException.


Contains enumerations of various types of error codes.


Contains classes and interfaces relating to AIE's enterprise service bus (esb) architecture, such as PlatformMessage, Grouped Message, ConnectorStatus, WorkflowQueue and MessageList.


Contains classes relating to AIE messages, such as Commit, ContentPointer, FlushDocuments, Optimize, IngestDocument, and others.


Models data from fields and describes how each field should be handled by the Attivio engine. Contains the SchemaSchemaField and FieldNames classes.

Contains classes related to query and response processing, such as QueryRequest, QueryResponse, QueryLanguages and SearchDocument.

Contains classes related to building facet lists, such as FacetRequest, FacetResponse, and FacetRange.

Contains classes that implement the FieldExpression features as applied in QueryRequests.

Contains classes related to the parsing of a QueryString into a Query object.

Contains classes relating to phrase queries such as PhraseNear, PhraseNot, and PhraseOr.

Contains classes related to relevancy, such as StaticBoost, ProximityBoost, and FreshnessBoost.

Contains classes related to the security model, such as AttivioAcl, AttivioPrincipal, and AttivioRole.


Contains classes relating to token manipulation, such as Token, TokenList, and TokenIterator.


A rich toolkit of utilities for working with dates, field expressions, geometry, locales, strings and tokens, among others.
  • No labels