IConceptModel.java

/*!
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* Copyright (c) 2002-2013 Pentaho Corporation..  All rights reserved.
*/

package org.pentaho.pms.ui.concept.editor;

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

import org.pentaho.pms.schema.concept.ConceptInterface;
import org.pentaho.pms.schema.concept.ConceptPropertyInterface;

/**
 * The model of a concept in the MVC sense. Acts as intermediary between concept and widget. Concept is modified through
 * this interface and events are fired accordingly.
 * @author mlowery
 */
public interface IConceptModel {
  /**
   * Relation type indicating the current concept.
   */
  int REL_THIS = 0;

  /**
   * Relation type indicating the parent of the current concept.
   */
  int REL_PARENT = 1;

  /**
   * Relation type indicating the concept of the parent subject.
   */
  int REL_INHERITED = 2;

  /**
   * Relation type indicating the concept's security parent.
   */
  int REL_SECURITY = 3;

  void setRelatedConcept(final ConceptInterface relatedConcept, final int relType);

  void removeRelatedConcept(final int relType);

  boolean hasRelatedConcept(final int relType);

  void setProperty(final ConceptPropertyInterface property);

  void removeProperty(final String id);

  ConceptPropertyInterface getEffectiveProperty(final String id);

  ConceptPropertyInterface getProperty(final String id, final int relType);

  Map getEffectivePropertyMap();

  Map getPropertyMap(final int relType);

  void clearProperties();

  Set getPropertyIds(final int relType);

  /**
   * Recursively searches related concepts (i.e. itself, its parent, its security parent, and its inherited). Returns
   * a list of strings showing the path from the this concept to the concept who originally contributed this property as
   * a child property..
   */
  List getPropertySource(final String id);

  /**
   * Returns one of <code>REL_THIS</code>, <code>REL_PARENT</code>, <code>REL_INHERITED</code>, or
   * <code>REL_SECURITY</code> indicating from where this property came. Note that a "contributor" does not necessarily
   * define this property--it could have itself inherited that property from an ancestor.
   */
  int getPropertyContributor(final String id);

  void addConceptModificationListener(final IConceptModificationListener conceptModelListener);

  void removeConceptModificationListener(final IConceptModificationListener conceptModelListener);

  boolean canOverride(final String id);

  boolean isOverridden(final String id);

  void setPropertyValue(final String id, final Object value);
}