oracle.toplink.essentials.queryframework.ColumnResult Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2005, Oracle. All rights reserved.
package oracle.toplink.essentials.queryframework;
import oracle.toplink.essentials.internal.localization.ExceptionLocalization;
import oracle.toplink.essentials.sessions.DatabaseRecord;
/**
* Purpose:
* Concrete class to represent the ColumnResult structure as defined by
* the EJB 3.0 Persistence specification. This class is a subcompent of the
* EntityResult
*
* @see EntityResult
* @author Gordon Yorke
* @since TopLink Java Essentials
*/
public class ColumnResult extends SQLResult{
/** Stores the Columns name from the result set */
protected String columnName;
public ColumnResult(String column){
this.columnName = column;
if (this.columnName == null){
throw new IllegalArgumentException(ExceptionLocalization.buildMessage("null_value_for_column_result"));
}
}
public String getColumnName(){
return this.columnName;
}
/**
* INTERNAL:
* This method is a convience method for extracting values from Results
*/
public Object getValueFromRecord(DatabaseRecord record, ResultSetMappingQuery query){
return record.get(this.columnName);
}
public boolean isColumnResult(){
return true;
}
}