org.apache.apex.malhar.lib.state.managed.ManagedTimeStateImpl.java Source code

Introduction

Here is the source code for org.apache.apex.malhar.lib.state.managed.ManagedTimeStateImpl.java

Source

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.apex.malhar.lib.state.managed;

import java.util.concurrent.Future;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

import org.apache.apex.malhar.lib.state.BucketedState;
import org.apache.apex.malhar.lib.state.TimeSlicedBucketedState;

import com.google.common.util.concurrent.Futures;

import com.datatorrent.api.Context;
import com.datatorrent.api.annotation.OperatorAnnotation;
import com.datatorrent.netlet.util.Slice;

/**
 * This implementation of {@link AbstractManagedStateImpl} lets the client to specify the time for each key.
 * The value of time is used to derive the time-bucket of a key.
 *
 * @since 3.4.0
 */
@OperatorAnnotation(checkpointableWithinAppWindow = false)
public class ManagedTimeStateImpl extends AbstractManagedStateImpl implements TimeSlicedBucketedState {
    public ManagedTimeStateImpl() {
        this.numBuckets = 1;
    }

    @Override
    public void put(long bucketId, long time, @NotNull Slice key, @NotNull Slice value) {
        long timeBucket = timeBucketAssigner.getTimeBucket(time);
        putInBucket(bucketId, timeBucket, key, value);
    }

    @Override
    public Slice getSync(long bucketId, @NotNull Slice key) {
        return getValueFromBucketSync(bucketId, -1, key);
    }

    @Override
    public Slice getSync(long bucketId, long time, @NotNull Slice key) {
        long timeBucket = timeBucketAssigner.getTimeBucket(time);
        if (timeBucket == -1) {
            //time is expired so no point in looking further.
            return BucketedState.EXPIRED;
        }
        return getValueFromBucketSync(bucketId, timeBucket, key);
    }

    @Override
    public Future<Slice> getAsync(long bucketId, Slice key) {
        return getValueFromBucketAsync(bucketId, -1, key);
    }

    @Override
    public Future<Slice> getAsync(long bucketId, long time, Slice key) {
        long timeBucket = timeBucketAssigner.getTimeBucket(time);
        if (timeBucket == -1) {
            //time is expired so no point in looking further.
            return Futures.immediateFuture(BucketedState.EXPIRED);
        }
        return getValueFromBucketAsync(bucketId, timeBucket, key);
    }

    @Min(1)
    @Override
    public long getNumBuckets() {
        return numBuckets;
    }

    @Override
    public void setup(Context.OperatorContext context) {
        super.setup(context);
    }

    /**
     * Sets the number of buckets.
     *
     * @param numBuckets number of buckets
     */
    public void setNumBuckets(int numBuckets) {
        this.numBuckets = numBuckets;
    }

}