com.bigdata.rdf.sparql.ast.QuadsDataOrNamedSolutionSet Maven / Gradle / Ivy

Go to download
/**

Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016.  All rights reserved.

Contact:
     SYSTAP, LLC DBA Blazegraph
     2501 Calvert ST NW #106
     Washington, DC 20008
     [email protected]

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.

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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
/*
 * Created on Mar 27, 2012
 */

package com.bigdata.rdf.sparql.ast;

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

import com.bigdata.bop.BOp;
import com.bigdata.bop.IVariable;
import com.bigdata.bop.NV;

/**
 * An AST node which models either {@link QuadData} or a named solution set in
 * support of the INSERT clause and DELETE clause of a {@link DeleteInsertGraph}
 * operations. Use {@link #isQuads()} or {@link #isSolutions()} to identify how
 * this AST node should be interpreted.
 * 
 * @author Bryan Thompson
 * @version $Id: QuadsDataOrNamedSolutionSet.java 6196 2012-03-27 20:06:22Z
 *          thompsonbry $
 * 
 *          TODO Rather than overriding this for two very different things
 *          (quads data and the name of a solution set) it might be better to
 *          relayer the AST model or just handle this via polymorphism in the
 *          {@link DeleteInsertGraph} AST node.
 */
public class QuadsDataOrNamedSolutionSet extends QueryNodeBase implements
        INamedSolutionSet, IProjectionDecl {

    /**
     * 
     */
    private static final long serialVersionUID = 1L;

    public interface Annotations extends QueryNodeBase.Annotations,
            INamedSolutionSet.Annotations, IProjectionDecl.Annotations {

        /**
         * The {@link QuadData} (optional; when present this is modeling QUADS
         * data).
         */
        String QUAD_DATA = "quadData";

    }
    
    /**
     * @param op
     */
    public QuadsDataOrNamedSolutionSet(final QuadsDataOrNamedSolutionSet op) {
        
        super(op);
        
    }

    /**
     * @param args
     * @param annotations
     */
    public QuadsDataOrNamedSolutionSet(final BOp[] args,
            final Map annotations) {

        super(args, annotations);

    }

    public QuadsDataOrNamedSolutionSet(final QuadData quadData) {

        super(BOp.NOARGS, NV.asMap(Annotations.QUAD_DATA, quadData));

    }

    public QuadsDataOrNamedSolutionSet(final String namedSet) {

        super(BOp.NOARGS, NV.asMap(Annotations.NAMED_SET, namedSet));

    }

    /**
     * Return the {@link QuadData} template.
     */
    public QuadData getQuadData() {

        return (QuadData) getProperty(Annotations.QUAD_DATA);

    }

    public void setQuadData(final QuadData data) {

        setProperty(Annotations.QUAD_DATA, data);

    }

    /**
     * Return true iff this models QUADS data (rather than named
     * solutions)
     */
    public boolean isQuads() {

        return getProperty(Annotations.QUAD_DATA)!=null;
        
    }
    
    /**
     * Return true iff this models a reference to some named
     * solutions (rather than QUADS data).
     */
    public boolean isSolutions() {

        return getProperty(Annotations.NAMED_SET) != null;
        
    }
    
    public String getName() {

        return (String) getProperty(Annotations.NAMED_SET);
        
    }

    public void setName(final String name) {

        setProperty(Annotations.NAMED_SET, name);
        
    }

    public void setProjection(final ProjectionNode projection) {

        setProperty(Annotations.PROJECTION, projection);

    }

    public ProjectionNode getProjection() {

        return (ProjectionNode) getProperty(Annotations.PROJECTION);

    }
    
    public Set> getProjectedVars(final Set> vars) {
        
        final ProjectionNode tmp = getProjection();
        
        if(tmp != null) {
            
            tmp.getProjectionVars(vars);
            
        }

        return vars;

    }

    @Override
    public String toString(final int indent) {

        final StringBuilder sb = new StringBuilder();

        final QuadData quadData = getQuadData();

        final String namedSolutionSet = getName();

        final ProjectionNode projection = getProjection();

        if (quadData != null) {
            sb.append("\n");
            sb.append(quadData.toString(indent));
        }

        if (namedSolutionSet != null) {
            sb.append("namedSet=" + namedSolutionSet);
        }
        if (projection != null) {
            sb.append("\n");
            sb.append(projection.toString(indent + 1));
        }

        return sb.toString();

    }

}