tmf/org.eclipse.tracecompass.tmf.analysis.xml.core/src/org/eclipse/tracecompass/internal/tmf/analysis/xml/core/model/readonly/TmfXmlReadOnlyStateAttribute.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014 École Polytechnique de Montréal
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Geneviève Bastien - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.internal.tmf.analysis.xml.core.model.readonly;
  14
  15 import org.eclipse.tracecompass.internal.tmf.analysis.xml.core.model.TmfXmlStateAttribute;
  16 import org.eclipse.tracecompass.internal.tmf.analysis.xml.core.module.IXmlStateSystemContainer;
  17 import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem;
  18 import org.eclipse.tracecompass.statesystem.core.exceptions.AttributeNotFoundException;
  19 import org.w3c.dom.Element;
  20
  21 /**
  22  * Implements a state attribute in a read only mode. See
  23  * {@link TmfXmlStateAttribute} for the syntax of this attribute.
  24  *
  25  * In read-only mode, attributes that are requested but do not exist in the
  26  * state system will not be added.
  27  *
  28  * @author Geneviève Bastien
  29  */
  30 public class TmfXmlReadOnlyStateAttribute extends TmfXmlStateAttribute {
  31
  32     /**
  33      * Constructor
  34      *
  35      * @param modelFactory
  36      *            The factory used to create XML model elements
  37      * @param attribute
  38      *            The XML element corresponding to this attribute
  39      * @param container
  40      *            The state system container this state value belongs to
  41      */
  42     public TmfXmlReadOnlyStateAttribute(TmfXmlReadOnlyModelFactory modelFactory, Element attribute, IXmlStateSystemContainer container) {
  43         super(modelFactory, attribute, container);
  44     }
  45
  46     @Override
  47     protected int getQuarkAbsoluteAndAdd(String... path) throws AttributeNotFoundException {
  48         ITmfStateSystem ss = getStateSystem();
  49         if (ss == null) {
  50             throw new IllegalStateException("The state system hasn't been initialized yet"); //$NON-NLS-1$
  51         }
  52         return ss.getQuarkAbsolute(path);
  53     }
  54
  55     @Override
  56     protected int getQuarkRelativeAndAdd(int startNodeQuark, String... path) throws AttributeNotFoundException {
  57         ITmfStateSystem ss = getStateSystem();
  58         if (ss == null) {
  59             throw new IllegalStateException("The state system hasn't been initialized yet"); //$NON-NLS-1$
  60         }
  61         return ss.getQuarkRelative(startNodeQuark, path);
  62     }
  63
  64 }