/**
Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016. All rights reserved.
Contact:
SYSTAP, LLC DBA Blazegraph
2501 Calvert ST NW #106
Washington, DC 20008
licenses@blazegraph.com
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 Aug 18, 2011
*/
package com.bigdata.rdf.sparql.ast;
/**
* An interface for an {@link IQueryNode} which may appear in an
* {@link IGroupNode}.
*
* @author <a href="mailto:thompsonbry@users.sourceforge.net">Bryan Thompson</a>
* @version $Id$
*/
public interface IGroupMemberNode extends IQueryNode, IVariableBindingRequirements {
/**
* Return the group to which this node belongs.
*/
IGroupNode<IGroupMemberNode> getParent();
/**
* Set the group to which this bindings producer node belongs. Should only
* be called the group node during the addChild() method.
*/
void setParent(final IGroupNode<IGroupMemberNode> parent);
/**
* Return the lowest {@link JoinGroupNode} which dominates this node. Note
* that some kinds of {@link IGroupMemberNode}s do not appear within a
* {@link JoinGroupNode} context. For example, {@link NamedSubqueryRoot} and
* {@link ConstructNode}.
*
* @return The {@link JoinGroupNode} -or- <code>null</code> if there is no
* such parent join group.
*/
JoinGroupNode getParentJoinGroup();
/**
* Return the lowest {@link GraphPatternGroup} which dominates this node.
* Note that some kinds of {@link IGroupMemberNode}s do not appear within a
* {@link GraphPatternGroup} context. For example, {@link NamedSubqueryRoot}
* and {@link ConstructNode}.
*
* @return The {@link GraphPatternGroup} -or- <code>null</code> if there is
* no such parent group.
*/
GraphPatternGroup<IGroupMemberNode> getParentGraphPatternGroup();
/**
* Return the context for the group graph pattern dominating this node.
*
* @return The context -or- <code>null</code> if there is no graph pattern
* dominating this node.
*/
TermNode getContext();
}