com.arpnetworking.tsdcore.sinks.DimensionInjectingSink.java Source code

Introduction

Here is the source code for com.arpnetworking.tsdcore.sinks.DimensionInjectingSink.java

Source

/**
 * Copyright 2016 Groupon.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.arpnetworking.tsdcore.sinks;

import com.arpnetworking.tsdcore.model.PeriodicData;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;
import net.sf.oval.constraint.NotNull;

import java.util.Map;

/**
 * Sink adds any specified dimensions.
 *
 * @author Ville Koskela (ville dot koskela at inscopemetrics dot com)
 */
public final class DimensionInjectingSink extends BaseSink {

    /**
     * {@inheritDoc}
     */
    @Override
    public void recordAggregateData(final PeriodicData data) {
        final Map<String, String> mergedDimensions = Maps.newHashMap(data.getDimensions());
        mergedDimensions.putAll(_dimensions);
        final PeriodicData.Builder dataBuilder = PeriodicData.Builder.clone(data);
        dataBuilder.setDimensions(ImmutableMap.copyOf(mergedDimensions));
        _sink.recordAggregateData(dataBuilder.build());
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void close() {
        // Nothing to do
    }

    private DimensionInjectingSink(final Builder builder) {
        super(builder);
        _sink = builder._sink;
        _dimensions = builder._dimensions;
    }

    private final Sink _sink;
    private final ImmutableMap<String, String> _dimensions;

    /**
     * Implementation of builder pattern for <code>DimensionInjectingSink</code>.
     *
     * @author Ville Koskela (ville dot koskela at inscopemetrics dot com)
     */
    public static final class Builder extends BaseSink.Builder<Builder, DimensionInjectingSink> {

        /**
         * Public constructor.
         */
        public Builder() {
            super(DimensionInjectingSink::new);
        }

        /**
         * Sets the dimensions to inject.
         *
         * @param value The dimensions to inject.
         * @return This instance of <code>Builder</code>.
         */
        public Builder setDimensions(final ImmutableMap<String, String> value) {
            _dimensions = value;
            return self();
        }

        /**
         * The sink to wrap. Cannot be null.
         *
         * @param value The sink to wrap.
         * @return This instance of <code>Builder</code>.
         */
        public Builder setSink(final Sink value) {
            _sink = value;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        protected Builder self() {
            return this;
        }

        @NotNull
        private ImmutableMap<String, String> _dimensions = ImmutableMap.of();
        @NotNull
        private Sink _sink;
    }
}