com.d3x.morpheus.viz.chart.pie.PieModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of d3x-morpheus-viz Show documentation
The newest version!
/*
 * Copyright (C) 2014-2018 D3X Systems - All Rights Reserved
 *
 * 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.d3x.morpheus.viz.chart.pie;

import com.d3x.morpheus.frame.DataFrame;

/**
 * An interface to the data model that is bound to a PiePlot.
 *
 * @author Xavier Witdouck
 *
 * This is open source software released under the Apache 2.0 License
 */
public interface PieModel {

    /**
     * Returns true if this dataset is empty
     * @return  true if no data
     */
    boolean isEmpty();

    /**
     * Returns an iterable for section keys
     * @return  the iterable of pie section keys
     */
    Iterable keys();

    /**
     * Clears all data for this dataset
     * @param notify    if true, fire notification event
     */
    void clear(boolean notify);

    /**
     * Applies data from the first numeric column in the DataFrame, using row keys as items
     * @param frame         the DataFrame reference
     */
    void apply(DataFrame frame);

    /**
     * Applies data from the specified column in the DataFrame, using row keys as items
     * @param frame         the DataFrame reference
     * @param valueKey       the column key that contains the pie plor data values
     */
    void apply(DataFrame frame, S valueKey);

    /**
     * Applies data from the valueKey column in the DataFrame, using items from the itemKey column
     * @param frame         the DataFrame reference
     * @param valueKey      the column key that contains the pie plor data values
     * @param itemKey       the column key that contains the pie plot labels
     */
    void apply(DataFrame frame, S itemKey, S valueKey);

}