[jira] [Commented] (APEXMALHAR-1897) Create ManagedState

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/APEXMALHAR-1897?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15202110#comment-15202110 ] 

ASF GitHub Bot commented on APEXMALHAR-1897:
--------------------------------------------

Github user amberarrow commented on a diff in the pull request:

    https://github.com/apache/incubator-apex-malhar/pull/145#discussion_r56718885
  
    --- Diff: library/src/main/java/com/datatorrent/lib/state/BucketedState.java ---
    @@ -0,0 +1,60 @@
    +/**
    + * 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 com.datatorrent.lib.state;
    +
    +import java.util.concurrent.Future;
    +
    +import com.datatorrent.netlet.util.Slice;
    +
    +/**
    + * A state where keys are grouped in buckets.
    + */
    +public interface BucketedState
    +{
    +  /**
    +   * Sets the value of the key in bucket identified by bucketId.
    +   *
    +   * @param bucketId identifier of the bucket.
    +   * @param key     key
    +   * @param value   value
    +   */
    +  void put(long bucketId, Slice key, Slice value);
    +
    +  /**
    +   * Returns the value of the key in a bucket identified by bucketId. Fetching a key can be expensive if the key
    +   * is not in memory and is present on disk. This fetches the key synchronously. <br/>
    +   * {@link #getAsync(long, Slice)} is recommended for efficiently reading the value of a key.
    +   *
    +   * @param bucketId identifier of the bucket.
    +   * @param key     key
    +   * @return        value
    +   */
    +  Slice getSync(long bucketId, Slice key);
    +
    +  /**
    +   * Returns the future using which the value is obtained.<br/>
    +   * If the key is present in memory, then the future has its value set when constructed.
    --- End diff --
    
    Suggest omitting "in memory" or replacing with "in the bucket" (multiple places)


> Create ManagedState
> -------------------
>
>                 Key: APEXMALHAR-1897
>                 URL: https://issues.apache.org/jira/browse/APEXMALHAR-1897
>             Project: Apache Apex Malhar
>          Issue Type: Sub-task
>            Reporter: Chandni Singh
>            Assignee: Chandni Singh
>             Fix For: 3.4.0
>
>
> ManagedState is described in the document below:
> https://docs.google.com/document/d/1gRWN9ufKSZSZD0N-pthlhpC9TZ8KwJ6hJlAX6nxl5f8/edit#heading=h.z87ti1fwyt0t



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)