projectiontreelabel.h

Go to the documentation of this file.

/*
 | Author: Michael Schmidt;
 |         Gunnar Jehl 
 |
 | ************************* SOFTWARE LICENSE AGREEMENT ***********************
 | This source code is published under the BSD License.
 |
 | See file 'LICENSE.txt' that comes with this distribution or
 | http://dbis.informatik.uni-freiburg.de/index.php?project=GCX/license.php
 | for the full license agreement.
 |
 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 | POSSIBILITY OF SUCH DAMAGE.
 | ****************************************************************************
*/

#ifndef PROJECTIONTREELABEL_H
#define PROJECTIONTREELABEL_H

#include "projectiontreenode.h"
#include "runtimeexception.h"

class ProjectionTreeLabel {

  public:
    ProjectionTreeLabel(ProjectionTreeNode * _n,
                        unsigned _position, unsigned _id,
                        ProjectionTreeLabel * _same_level_successor,
                        vector < ProjectionTreeLabel * >_child_successors,
                        vector < ProjectionTreeLabel * >_self_successors);

     virtual ~ ProjectionTreeLabel();

    void updateParentPredecessorInformation(ProjectionTreeLabel * _parent,
                                            ProjectionTreeLabel * _predecessor);

    void print(OutputStream & dos);

    inline ProjectionTreeLabel *getParent() {
        return parent;
    } inline ProjectionTreeLabel *getPredecessor() {
        return predecessor;
    }

    ProjectionTreeLabel *getLeftmostSLPredecessor();

    unsigned getDependingVar();

    PathExpression *getPath();

    PathStepExpression *getPathStep();

    TAG getTag();

    AXIS_TYPE getAxisFollowingFSA();

    AXIS_TYPE getAxisFollowingFSA(unsigned fsa);

    ProjectionTreeLabel *getFSALabel();

    inline unsigned getId() {
        return id;
    }

    inline unsigned getPosition() {
        return position;
    }

    inline ProjectionTreeLabel *getSameLevelSuccessor() {
        return same_level_successor;
    }

    inline vector < ProjectionTreeLabel * >*getChildSuccessors() {
        return &child_successors;
    }

    inline vector < ProjectionTreeLabel * >*getSelfSuccessors() {
        return &self_successors;
    }

    inline ProjectionTreeNode *getProjectionTreeNode() {
        return n;
    }

    bool isChildOrDescendantLabel();

    bool isDescendantLabel();

    bool isChildLabel();

    bool isDosLabel();

    bool isDosNodeLabel();

    bool isDosOrDescendantLabel();

    bool isNodeLabel();

    bool isStarLabel();

    bool hasSameLevelOrChildSuccessors();

    bool atEndOfPath();

    ProjectionTreeLabel *locateVarAncestorLabel(unsigned var);

    bool matchesTag(TAG t);

    bool matchesText();

    bool descendantAxisBetw(unsigned basing_id, bool consider_final = false);

  private:
    ProjectionTreeLabel * parent;

    ProjectionTreeLabel *predecessor;

    ProjectionTreeNode *n;

    unsigned position;

    unsigned id;

    ProjectionTreeLabel *same_level_successor;

    vector < ProjectionTreeLabel * >child_successors;

    vector < ProjectionTreeLabel * >self_successors;
};

#endif // PROJECTIONTREELABEL_H

---