Package org.opencastproject.index.service.catalog.adapter

Class ConfigurableDCCatalogUIAdapter

java.lang.Object
org.opencastproject.index.service.catalog.adapter.ConfigurableDCCatalogUIAdapter
All Implemented Interfaces:
CatalogUIAdapter
Direct Known Subclasses:
ConfigurableEventDCCatalogUIAdapter, ConfigurableSeriesDCCatalogUIAdapter
public abstract class ConfigurableDCCatalogUIAdapter extends Object implements CatalogUIAdapter

  • Field Details

    • config

      protected CatalogUIAdapterConfiguration config
      The catalog UI adapter configuration

    • organization

      protected String organization
      The organization name

    • flavor

      protected MediaPackageElementFlavor flavor
      The flavor of this catalog

    • title

      protected String title
      The title of this catalog

    • dublinCoreProperties

      protected Map<String,MetadataField> dublinCoreProperties
      The metadata fields for all properties of the underlying DublinCore

    • listProvidersService

      protected ListProvidersService listProvidersService
      Reference to the list providers service

  • Constructor Details

    • ConfigurableDCCatalogUIAdapter

      public ConfigurableDCCatalogUIAdapter()

  • Method Details

    • updated

      public void updated(Dictionary<String,?> properties) throws org.osgi.service.cm.ConfigurationException
      Reconfigures the SeriesCatalogUIAdapter instance with an updated set of configuration properties;
      Parameters:
      properties - the configuration properties
      Throws:
      org.osgi.service.cm.ConfigurationException - if there is a configuration error

    • getRawFields

      public DublinCoreMetadataCollection getRawFields()
      Description copied from interface: CatalogUIAdapter
      Returns all fields of this catalog in a raw data format. This is a good starting point to create a new instance of this catalog.
      Specified by:
      getRawFields in interface CatalogUIAdapter
      Returns:
      The fields with raw data

    • getRawFields

      public DublinCoreMetadataCollection getRawFields(Map<String,ResourceListQuery> collectionQueryOverrides)
      Description copied from interface: CatalogUIAdapter
      Returns all fields of this catalog in a raw data format. Allows to hand over custom queries to fill the collection of a metadata field (defined by its output id) from a list provider.
      Specified by:
      getRawFields in interface CatalogUIAdapter
      Parameters:
      collectionQueryOverrides - A map of custom list provider queries mapped to metadata fields by the output id. Can be empty.
      Returns:
      The fields with raw data

    • getRawFields

      public DublinCoreMetadataCollection getRawFields(ResourceListQuery collectionQueryOverride)
      Description copied from interface: CatalogUIAdapter
      Returns all fields of this catalog in a raw data format. Allows to hand over custom queries to fill the collection of a metadata field (defined by its output id) from a list provider.
      Specified by:
      getRawFields in interface CatalogUIAdapter
      Parameters:
      collectionQueryOverride - A custom list provider query mapped to every metadata field.
      Returns:
      The fields with raw data

    • getFieldsFromCatalogs

      protected DublinCoreMetadataCollection getFieldsFromCatalogs(List<DublinCoreCatalog> dcCatalogs)

    • getOrganization

      public String getOrganization()
      Description copied from interface: CatalogUIAdapter
      Returns the name of the organization (tenant) this catalog UI adapter belongs to or "*" if this is a tenant-agnostic adapter.
      Specified by:
      getOrganization in interface CatalogUIAdapter
      Returns:
      The organization name or "*"

    • handlesOrganization

      public boolean handlesOrganization(String organization)
      Description copied from interface: CatalogUIAdapter
      Check if the catalog UI adapter belongs to a tenant.
      Specified by:
      handlesOrganization in interface CatalogUIAdapter
      Returns:
      true if adapter belongs to tenant.

    • getFlavor

      public MediaPackageElementFlavor getFlavor()
      Description copied from interface: CatalogUIAdapter
      Returns the media type of catalogs managed by this catalog UI adapter.
      Specified by:
      getFlavor in interface CatalogUIAdapter
      Returns:
      The media type of the catalog

    • getUITitle

      public String getUITitle()
      Specified by:
      getUITitle in interface CatalogUIAdapter
      Returns:
      Get the human readable title for this catalog ui adapter for various languages.

    • setListProvidersService

      public void setListProvidersService(ListProvidersService listProvidersService)

    • getListProvidersService

      protected ListProvidersService getListProvidersService()