com.imsweb.decisionengine.Table Maven / Gradle / Ivy

/*
 * Copyright (C) 2014 Information Management Services, Inc.
 */
package com.imsweb.decisionengine;

import java.util.List;
import java.util.Set;

/**
 * A table definition used in the Algorithm
 */
public interface Table {

    /**
     * A unique identifier for the table
     * @return a String representing the table identifier
     */
    String getId();

    /**
     * Return a list of the column definitions
     * @return a List of ColumnDefinition
     */
    List getColumnDefinitions();

    /**
     * Returns a list of input keys that are references in the table rows.  References are in the format "{{key}}".
     * @return a list of input keys
     */
    Set getExtraInput();

    /**
     * Return the data of the table as a list of rows
     * @return a List of TableRow objects
     */
    List getTableRows();

}