org.eclipse.persistence.jpa.jpql.EclipseLinkLiteralVisitor Maven / Gradle / Ivy
Show all versions of eclipselink Show documentation
/*******************************************************************************
* Copyright (c) 2011, 2013 Oracle and/or its affiliates. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
* which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* Contributors:
* Oracle - initial API and implementation
*
******************************************************************************/
package org.eclipse.persistence.jpa.jpql;
import org.eclipse.persistence.jpa.jpql.parser.AsOfClause;
import org.eclipse.persistence.jpa.jpql.parser.CastExpression;
import org.eclipse.persistence.jpa.jpql.parser.ConnectByClause;
import org.eclipse.persistence.jpa.jpql.parser.DatabaseType;
import org.eclipse.persistence.jpa.jpql.parser.EclipseLinkExpressionVisitor;
import org.eclipse.persistence.jpa.jpql.parser.ExtractExpression;
import org.eclipse.persistence.jpa.jpql.parser.HierarchicalQueryClause;
import org.eclipse.persistence.jpa.jpql.parser.OrderSiblingsByClause;
import org.eclipse.persistence.jpa.jpql.parser.RegexpExpression;
import org.eclipse.persistence.jpa.jpql.parser.StartWithClause;
import org.eclipse.persistence.jpa.jpql.parser.TableExpression;
import org.eclipse.persistence.jpa.jpql.parser.TableVariableDeclaration;
import org.eclipse.persistence.jpa.jpql.parser.UnionClause;
/**
* This visitor traverses an {@link org.eclipse.persistence.jpa.jpql.parser.Expression Expression}
* and retrieves the "literal" value. The literal to retrieve depends on the {@link LiteralType type}.
* The literal is basically a string value like an identification variable name, an input parameter,
* a path expression, an abstract schema name, etc.
*
* Provisional API: This interface is part of an interim API that is still under development and
* expected to change significantly before reaching stability. It is available at this early stage
* to solicit feedback from pioneering adopters on the understanding that any code that uses this
* API will almost certainly be broken (repeatedly) as the API evolves.
*
* @version 2.5
* @since 2.4
* @author Pascal Filion
*/
public class EclipseLinkLiteralVisitor extends LiteralVisitor
implements EclipseLinkExpressionVisitor {
/**
* Creates a new EclipseLinkLiteralVisitor.
*/
public EclipseLinkLiteralVisitor() {
super();
}
/**
* {@inheritDoc}
*/
public void visit(AsOfClause expression) {
}
/**
* {@inheritDoc}
*/
public void visit(CastExpression expression) {
}
/**
* {@inheritDoc}
*/
public void visit(ConnectByClause expression) {
}
/**
* {@inheritDoc}
*/
public void visit(DatabaseType expression) {
if (type == LiteralType.STRING_LITERAL) {
literal = expression.getActualIdentifier();
}
}
/**
* {@inheritDoc}
*/
public void visit(ExtractExpression expression) {
}
/**
* {@inheritDoc}
*/
public void visit(HierarchicalQueryClause expression) {
}
/**
* {@inheritDoc}
*/
public void visit(OrderSiblingsByClause expression) {
}
/**
* {@inheritDoc}
*/
public void visit(RegexpExpression expression) {
}
/**
* {@inheritDoc}
*/
public void visit(StartWithClause expression) {
}
/**
* {@inheritDoc}
*/
public void visit(TableExpression expression) {
if (type == LiteralType.STRING_LITERAL) {
expression.getExpression().accept(this);
}
}
/**
* {@inheritDoc}
*/
public void visit(TableVariableDeclaration expression) {
}
/**
* {@inheritDoc}
*/
public void visit(UnionClause expression) {
}
}