Package com.activeviam.copper

Class AMeasurePublisher

  • All Implemented Interfaces:
    com.activeviam.copper.private_.IMeasurePublisher
    Direct Known Subclasses:
    DataCubeMeasurePublisher
    @Deprecated(since="6.0.6",
            forRemoval=true)
public abstract class AMeasurePublisher
extends Object
implements com.activeviam.copper.private_.IMeasurePublisher
    Deprecated, for removal: This API element is subject to removal in a future version.
    Abstract implementation of an IMeasurePublisher.
    Author:
    ActiveViam

    • Field Detail

      • measureOptimizer

        public final MeasureOptimizer measureOptimizer
        Deprecated, for removal: This API element is subject to removal in a future version.
        The object which handles the measure optimizations before publication.

    • Method Detail

      • getCubeMeasureDescription

        public IMeasureMemberDescription getCubeMeasureDescription​(String measureName)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: com.activeviam.copper.private_.IMeasurePublisher
        Gets the description of the given measure.

        Only works if the measure existed before creating the ICopperContext.

        Specified by:
        getCubeMeasureDescription in interface com.activeviam.copper.private_.IMeasurePublisher

      • getMeasureNameProvider

        public Function<IInternalCopperMeasure,​String> getMeasureNameProvider()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the name provider.
        Specified by:
        getMeasureNameProvider in interface com.activeviam.copper.private_.IMeasurePublisher
        Returns:
        the name provider

      • getMeasuresToPublish

        public Set<IMeasureMemberDescription> getMeasuresToPublish()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: com.activeviam.copper.private_.IMeasurePublisher
        Returns the added measures to use to enrich the cube.
        Specified by:
        getMeasuresToPublish in interface com.activeviam.copper.private_.IMeasurePublisher
        Returns:
        the added measures to use to enrich the cube

      • getOriginalMeasureInstance

        public IInternalCopperMeasure getOriginalMeasureInstance​(IInternalCopperMeasure namedMeasure)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: com.activeviam.copper.private_.IMeasurePublisher
        Fetches the original CopperMeasure instance that was used to create a namedMeasure.
        Specified by:
        getOriginalMeasureInstance in interface com.activeviam.copper.private_.IMeasurePublisher
        Parameters:
        namedMeasure - the NamedMeasure instance
        Returns:
        the original CopperMeasure that was published under the same name as the current named measure, or null if this measure was defined outside of Copper's scope

      • addPublicationMetadata

        public void addPublicationMetadata​(IInternalCopperMeasure measure,
                                   IMeasureMemberDescription measureDescriptionWithoutMetadata,
                                   MeasureMetadata publicationMetadata)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Mutates a measure description to take into account publication metadata.
        Parameters:
        measure - the Copper measure
        measureDescriptionWithoutMetadata - the measure description to update in-place.
        publicationMetadata - the metadata containing multiple attributes to apply to the description

      • getPublishedMeasureDescription

        public IMeasureMemberDescription getPublishedMeasureDescription​(String measureName)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the description of the measure or null if it has not been published.
        Parameters:
        measureName - the name of the measure
        Returns:
        the measure description

      • retrieveMeasureDescription

        public IMeasureMemberDescription retrieveMeasureDescription​(String measureName)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: com.activeviam.copper.private_.IMeasurePublisher
        Finds the IMeasureMemberDescription of a measure already published or exists in the original cube description. If none is found, it means the user made a mistake referencing an unknown/unpublished measure.
        Specified by:
        retrieveMeasureDescription in interface com.activeviam.copper.private_.IMeasurePublisher
        Parameters:
        measureName - the name of the measure
        Returns:
        the IMeasureMemberDescription corresponding to the given measure

      • getOrComputeMeasureType

        public int getOrComputeMeasureType​(IInternalCopperMeasure measure)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Gets the type of a measure if present, else computes it.
        Specified by:
        getOrComputeMeasureType in interface com.activeviam.copper.private_.IMeasurePublisher
        Returns:
        the type of the measure

      • shouldMeasureNameBeUnique

        public static boolean shouldMeasureNameBeUnique​(IInternalCopperMeasure measure)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks if the name of the given measure should be unique. It is true for native measure and measure for which the user specified a name.
        Parameters:
        measure - the measure
        Returns:
        true if the name should be unique, false otherwise

      • publish

        public void publish​(IInternalCopperMeasure measureToPublish)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: com.activeviam.copper.private_.IMeasurePublisher
        Publishes the given measure.
        Specified by:
        publish in interface com.activeviam.copper.private_.IMeasurePublisher
        Parameters:
        measureToPublish - the measure to publish