// ============================================================================
//
// Copyright (C) 2006-2016 Talend Inc. - www.talend.com
//
// This source code is available under agreement available at
// %InstallDIR%\features\org.talend.rcp.branding.%PRODUCTNAME%\%PRODUCTNAME%license.txt
//
// You should have received a copy of the agreement
// along with this program; if not, write to Talend SA
// 9 rue Pages 92150 Suresnes, France
//
// ============================================================================
package org.talend.dq.nodes.indicator;

import org.talend.dataquality.indicators.Indicator;
import org.talend.dq.nodes.indicator.type.IndicatorEnum;

/**
 * @author rli
 * 
 */
public interface IIndicatorNode {

    public IIndicatorNode[] getChildren();

    public boolean hasChildren();

    public IIndicatorNode getParent();

    public void setParent(IIndicatorNode indicatorNode);

    /**
     * @return the indicatorFieldEnum
     */
    public IndicatorEnum getIndicatorEnum();

    /**
     * 
     * Set the indicatorEnum for current node
     * 
     * @param indicatorEnum The enum which will be setting
     */
    public void setIndicatorEnum(IndicatorEnum indicatorEnum);

    /**
     * 
     * Get the instance of indicator if don't create it yet then create one
     * 
     * @return
     */
    public Indicator getIndicatorInstance();

    /**
     * 
     * Create a new instance of indicator will not get from {@link #getIndicatorInstance()}
     * 
     * @return
     */
    public Indicator createNewIndicatorInstance();

    public String getLabel();

    public boolean isIndicatorEnumNode();

    /**
     * 
     * Get the name of image
     * 
     * @return The name of image
     */
    public String getImageName();

}