org.eclipse.persistence.jpa.jpql.tools.model.query.IndexExpressionStateObject Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation
Show all versions of eclipselink Show documentation
EclipseLink build based upon Git transaction 180e602
/*******************************************************************************
* Copyright (c) 2011, 2014 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.tools.model.query;
import org.eclipse.persistence.jpa.jpql.parser.IndexExpression;
import static org.eclipse.persistence.jpa.jpql.parser.Expression.*;
/**
* The INDEX
function returns an integer value corresponding to the position of
* its argument in an ordered list. The INDEX
function can only be applied to
* identification variables denoting types for which an order column has been specified.
*
* BNF: expression ::= INDEX(identification_variable)
*
* @see IndexExpression
*
* @version 2.4
* @since 2.4
* @author Pascal Filion
*/
public class IndexExpressionStateObject extends EncapsulatedIdentificationVariableExpressionStateObject {
/**
* Creates a new IndexExpressionStateObject
.
*
* @param parent The parent of this state object, which cannot be null
* @exception NullPointerException The given parent cannot be null
*/
public IndexExpressionStateObject(StateObject parent) {
super(parent);
}
/**
* Creates a new IndexExpressionStateObject
.
*
* @param parent The parent of this state object, which cannot be null
* @param identificationVariable The name of the identification variable
* @exception NullPointerException The given parent cannot be null
*/
public IndexExpressionStateObject(StateObject parent, String identificationVariable) {
super(parent, identificationVariable);
}
/**
* {@inheritDoc}
*/
public void accept(StateObjectVisitor visitor) {
visitor.visit(this);
}
/**
* {@inheritDoc}
*/
@Override
public IndexExpression getExpression() {
return (IndexExpression) super.getExpression();
}
/**
* {@inheritDoc}
*/
@Override
public String getIdentifier() {
return INDEX;
}
/**
* Keeps a reference of the {@link IndexExpression parsed object} object, which should only be
* done when this object is instantiated during the conversion of a parsed JPQL query into
* {@link StateObject StateObjects}.
*
* @param expression The {@link IndexExpression parsed object} representing an INDEX
* expression
*/
public void setExpression(IndexExpression expression) {
super.setExpression(expression);
}
}