Open Source Repository

Home /hibernate/hibernate-3.2.6.ga | Repository Home


org/hibernate/hql/ast/tree/FromReferenceNode.java
// $Id: FromReferenceNode.java 7494 2005-07-15 16:20:04Z steveebersole $
package org.hibernate.hql.ast.tree;

import antlr.SemanticException;
import antlr.collections.AST;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Represents a reference to a FROM element, for example a class alias in a WHERE clause.
 *
 @author josh Jul 21, 2004 7:02:04 AM
 */
public abstract class FromReferenceNode extends AbstractSelectExpression
        implements ResolvableNode, DisplayableNode, InitializeableNode, PathNode {

  private static final Log log = LogFactory.getLogFromReferenceNode.class );

  private FromElement fromElement;
  private boolean resolved = false;
  public static final int ROOT_LEVEL = 0;

  public FromElement getFromElement() {
    return fromElement;
  }

  public void setFromElement(FromElement fromElement) {
    this.fromElement = fromElement;
  }

  /**
   * Resolves the left hand side of the DOT.
   *
   @throws SemanticException
   */
  public void resolveFirstChild() throws SemanticException {
  }

  public String getPath() {
    return getOriginalText();
  }

  public boolean isResolved() {
    return resolved;
  }

  public void setResolved() {
    this.resolved = true;
    if log.isDebugEnabled() ) {
      log.debug"Resolved :  " this.getPath() " -> " this.getText() );
    }
  }

  public String getDisplayText() {
    StringBuffer buf = new StringBuffer();
    buf.append"{" ).append( ( fromElement == null "no fromElement" : fromElement.getDisplayText() );
    buf.append"}" );
    return buf.toString();
  }

  public void recursiveResolve(int level, boolean impliedAtRoot, String classAliasthrows SemanticException {
    recursiveResolvelevel, impliedAtRoot, classAlias, this );
  }

  public void recursiveResolve(int level, boolean impliedAtRoot, String classAlias, AST parentthrows SemanticException {
    AST lhs = getFirstChild();
    int nextLevel = level + 1;
    if lhs != null ) {
      FromReferenceNode n = FromReferenceNode lhs;
      n.recursiveResolvenextLevel, impliedAtRoot, null, this );
    }
    resolveFirstChild();
    boolean impliedJoin = true;
    if level == ROOT_LEVEL && !impliedAtRoot ) {
      impliedJoin = false;
    }
    resolvetrue, impliedJoin, classAlias, parent );
  }

  public boolean isReturnableEntity() throws SemanticException {
    return !isScalar() && fromElement.isEntity();
  }

  public void resolveInFunctionCall(boolean generateJoin, boolean implicitJointhrows SemanticException {
    resolvegenerateJoin, implicitJoin );
  }

  public void resolve(boolean generateJoin, boolean implicitJointhrows SemanticException {
    resolvegenerateJoin, implicitJoin, null );
  }

  public void resolve(boolean generateJoin, boolean implicitJoin, String classAliasthrows SemanticException {
    resolvegenerateJoin, implicitJoin, classAlias, null );
  }

  public void prepareForDot(String propertyNamethrows SemanticException {
  }

  /**
   * Sub-classes can override this method if they produce implied joins (e.g. DotNode).
   *
   @return an implied join created by this from reference.
   */
  public FromElement getImpliedJoin() {
    return null;
  }

}