cassandra-trunk/src/java/org/apache/cassandra/db/rows/Unfiltered.java
/*
 * 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.cassandra.db.rows;

import org.apache.cassandra.db.ClusteringPrefix;
import org.apache.cassandra.db.Digest;
import org.apache.cassandra.schema.TableMetadata;
import org.apache.cassandra.db.Clusterable;

/**
 * Unfiltered is the common class for the main constituent of an unfiltered partition.
 * <p>
 * In practice, an Unfiltered is either a row or a range tombstone marker. Unfiltereds
 * are uniquely identified by their clustering information and can be sorted according
 * to those.
 *
 * We don't set the type parameter for Clusterable here because it doesn't make sense in
 * the context of an Unfiltered. Merge iterators can produce rows containing clustering
 * and cell values with multiple backing types. Also, by the time you're dealing with
 * Unfiltered objects, the backing type should be considered opaque.
 */
public interface Unfiltered extends Clusterable
{
    public enum Kind { ROW, RANGE_TOMBSTONE_MARKER }

    /**
     * The kind of the atom: either row or range tombstone marker.
     */
    public Kind kind();

    ClusteringPrefix<?> clustering();

    /**
     * Digest the atom using the provided {@link Digest}.
     *
     * @param digest the {@see Digest} to use.
     */
    public void digest(Digest digest);

    /**
     * Validate the data of this atom.
     *
     * @param metadata the metadata for the table this atom is part of.
     * @throws org.apache.cassandra.serializers.MarshalException if some of the data in this atom is
     * invalid (some value is invalid for its column type, or some field
     * is nonsensical).
     */
    public void validateData(TableMetadata metadata);

    /**
     * Do a quick validation of the deletions of the unfiltered (if any)
     *
     * @return true if any deletion is invalid
     */
    public boolean hasInvalidDeletions();
    public boolean isEmpty();

    public String toString(TableMetadata metadata);
    public String toString(TableMetadata metadata, boolean fullDetails);
    public String toString(TableMetadata metadata, boolean includeClusterKeys, boolean fullDetails);

    default boolean isRow()
    {
        return kind() == Kind.ROW;
    }

    default boolean isRangeTombstoneMarker()
    {
        return kind() == Kind.RANGE_TOMBSTONE_MARKER;
    }
}
