accumulo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dhutchis <...@git.apache.org>
Subject [GitHub] accumulo pull request #145: ACCUMULO-4376 add KeyBuilder
Date Fri, 02 Sep 2016 03:32:35 GMT
Github user dhutchis commented on a diff in the pull request:

    https://github.com/apache/accumulo/pull/145#discussion_r77288983
  
    --- Diff: core/src/main/java/org/apache/accumulo/core/data/KeyBuilder.java ---
    @@ -0,0 +1,300 @@
    +/*
    + * 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.accumulo.core.data;
    +
    +
    +import org.apache.hadoop.io.Text;
    +
    +/**
    + * A builder used to build {@link Key}s by defining their components.
    + *
    + * The rules are:
    + * <ul>
    + *   <li>All components of the {@link Key} are optional except the row</li>
    + *   <li>Components not explicitly set default to empty byte array except the timestamp
which
    + *   defaults to <code>Long.MAX_VALUE</code></li>
    + *   <li>The column qualifier can only be set if the column family has been set
first</li>
    + *   <li>The column visibility can only be set if at least the column family has
been set first</li>
    + * </ul>
    + *
    + * The builder supports three types of components: <code>byte[]</code>, <code>Text</code>
and <code>CharSequence</code>.
    + *
    + * The builder is mutable and not thread safe.
    + *
    + * @see org.apache.accumulo.core.data.Key
    + * @since 1.8
    + */
    +public class KeyBuilder {
    +
    +  public interface Build {
    +
    +    /**
    +     * Build a {@link Key} from this builder. copyBytes defaults to true.
    +     *
    +     * @return
    +     *          the {@link Key} built from this builder
    +     */
    +    Key build();
    +
    +    /**
    +     * Change the timestamp of the {@link Key} created.
    +     *
    +     * @param timestamp
    +     *          the timestamp to use for the {@link Key}
    +     * @return this builder
    +     */
    +    Build timestamp(long timestamp);
    +
    +    /**
    +     * Set the deleted marker of the {@link Key} to the parameter.
    +     *
    +     * @param deleted
    +     *          if the {@link Key} should be marked as deleted or not
    +     * @return this builder
    +     */
    +    Build deleted(boolean deleted);
    +  }
    +
    +  public interface RowStep extends Build {
    +
    +    /**
    +     * Set the row of the {@link Key} that this builder will build to the parameter.
    +     *
    +     * @param row
    +     *          the row to use for the key
    +     * @return this builder
    +     */
    +    ColumnFamilyStep row(final Text row);
    +
    +    /**
    +     * Set the row of the {@link Key} that this builder will build to the parameter.
    +     *
    +     * @param row
    +     *          the row to use for the key
    +     * @return this builder
    +     */
    +    ColumnFamilyStep row(final byte[] row);
    +
    +    /**
    +     * Set the row of the {@link Key} that this builder will build to the parameter.
    +     *
    +     * @param row
    +     *          the row to use for the key
    +     * @return this builder
    +     */
    +    ColumnFamilyStep row(final CharSequence row);
    +  }
    +
    +  public interface ColumnFamilyStep extends ColumnVisibilityStep {
    +
    +    /**
    +     * Set the column family of the {@link Key} that this builder will build to the parameter.
    +     *
    +     * @param columnFamily
    +     *          the column family to use for the {@link Key}
    +     * @return this builder
    +     */
    +    ColumnQualifierStep family(final byte[] columnFamily);
    +
    +    /**
    +     * Set the column family of the {@link Key} that this builder will build to the parameter.
    +     *
    +     * @param columnFamily
    +     *          the column family to use for the {@link Key}
    +     * @return this builder
    +     */
    +    ColumnQualifierStep family(final Text columnFamily);
    +
    +    /**
    +     * Set the column family of the {@link Key} that this builder will build to the parameter.
    +     *
    +     * @param columnFamily
    +     *          the column family to use for the {@link Key}
    +     * @return this builder
    +     */
    +    ColumnQualifierStep family(final CharSequence columnFamily);
    +  }
    +
    +  public interface ColumnQualifierStep extends ColumnVisibilityStep {
    +
    +    /**
    +     * Set the column qualifier of the {@link Key} that this builder will build to the
parameter.
    +     *
    +     * @param columnQualifier
    +     *          the column qualifier to use for the {@link Key}
    +     * @return this builder
    +     */
    +    ColumnVisibilityStep qualifier(final byte[] columnQualifier);
    +
    +    /**
    +     * Set the column qualifier of the {@link Key} that this builder will build to the
parameter.
    +     *
    +     * @param columnQualifier
    +     *          the column qualifier to use for the {@link Key}
    +     * @return this builder
    +     */
    +    ColumnVisibilityStep qualifier(final Text columnQualifier);
    +
    +    /**
    +     * Set the column qualifier of the {@link Key} that this builder will build to the
parameter.
    +     *
    +     * @param columnQualifier
    +     *          the column qualifier to use for the {@link Key}
    +     * @return this builder
    +     */
    +    ColumnVisibilityStep qualifier(final CharSequence columnQualifier);
    +  }
    +
    +  public interface ColumnVisibilityStep extends Build {
    +
    +    /**
    +     * Set the column qualifier of the {@link Key} that this builder will build to the
parameter.
    +     *
    +     * @param columnVisibility
    +     *          the column visibility to use for the {@link Key}
    +     * @return this builder
    +     */
    +    Build visibility(final byte[] columnVisibility);
    +
    +    /**
    +     * Set the column qualifier of the {@link Key} that this builder will build to the
parameter.
    +     *
    +     * @param columnVisibility
    +     *          the column visibility to use for the {@link Key}
    +     * @return this builder
    +     */
    +    Build visibility(final Text columnVisibility);
    +
    +    /**
    +     * Set the column qualifier of the {@link Key} that this builder will build to the
parameter.
    +     *
    +     * @param columnVisibility
    +     *          the column visibility to use for the {@link Key}
    +     * @return this builder
    +     */
    +    Build visibility(final CharSequence columnVisibility);
    +  }
    +
    +  static class AbstractKeyBuilder implements RowStep, ColumnFamilyStep, ColumnQualifierStep,
    --- End diff --
    
    Since this class is no longer abstract, rename to `KeyBuilder`.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message