oracle.toplink.essentials.queryframework.FieldResult 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, 2007, 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 FieldResult 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 FieldResult {
/** Stores the name of the bean attribute */
protected String attributeName;
/** Stores passed in field name split on the '.' character */
protected String[] multipleFieldIdentifiers;
/** FieldResult now can contain multiple FieldResults in a collection if an attribute has multiple fields */
java.util.Vector fieldResults;
/** Stores the Columns name from the result set that contains the attribute value */
protected String columnName;
public FieldResult(String attributeName, String column){
this.columnName = column;
if (attributeName == null || this.columnName == null){
throw new IllegalArgumentException(ExceptionLocalization.buildMessage("null_values_for_field_result"));
}
multipleFieldIdentifiers = attributeName.split("\\.",0);
this.attributeName = multipleFieldIdentifiers[0];
}
public String getAttributeName(){
return this.attributeName;
}
public String getColumnName(){
return this.columnName;
}
/**
* INTERNAL:
* This method is a convience method for extracting values from Results
*/
public Object getValueFromRecord(DatabaseRecord record){
return record.get(this.columnName);
}
/**
* INTERNAL:
*/
public java.util.Vector getFieldResults(){
return fieldResults;
}
/**
* INTERNAL:
*/
public String[] getMultipleFieldIdentifiers(){
return multipleFieldIdentifiers;
}
/**
* INTERNAL:
* This method is used to support mapping multiple fields, fields are
* concatenated/added to one fieldResult.
*/
public void add(FieldResult newFieldResult){
if( fieldResults ==null){
fieldResults = new java.util.Vector();
fieldResults.add(this);
}
fieldResults.add(newFieldResult);
}
}