Co-Curator

Co-Curator Java library

Use the Java library to modify the content of Composables and access the Co-Curator content for playout.

The relations between Composables, Sections and Entries, are stored in a number of Sophora YellowData fields and child nodes.To make these easier accessible to your playout, use the Java library sophora-cocurator.

To use the sophora-cocurator library, add the following dependency to the Maven Project Object Model (POM):

<dependency>
<groupId>com.subshell.sophora</groupId>
<artifactId>sophora-cocurator</artifactId>
<version>1.0.0</version>
</dependency>

The main class in this library is called ComposableManager and can be created with an ISophoraClient.

The ReadonlyComposableManager interface contains all the methods you'll need for playout. It includes the following methods:

  • getFragmentedComposable(String): This method returns the current (working) view of a Composable specified by an ID. It relies on a Solr search and should be used only for previews.
  • getAggregatedComposable(String): This method returns the latest aggregated view on a Composable. Aggregation is an action that stores all data from Sections and Entries into the Composable. The result of this method doesn't rely on Solr search, making it as current as the Composable document itself.
  • getPublishedAggregatedComposable(String): This method is similar to getAggregatedComposable, but it's based on the published version of the Composable. If your ISophoraClient is connected to a Sophora Staging Server, both methods return the same result. All getter methods for Composables return objects that grant structured access to their Sections and Entries.

Last modified on 11/30/20

The content of this page is licensed under the CC BY 4.0 License. Code samples are licensed under the MIT License.

Icon