oracle.toplink.essentials.queryframework.ConstructorReportItem Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of toplink-essentials
There is a newer version: 2.1-60f
/*
 * 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 java.util.Vector;
import java.util.List;
import oracle.toplink.essentials.exceptions.QueryException;
import oracle.toplink.essentials.expressions.Expression;
import oracle.toplink.essentials.internal.queryframework.ReportItem;


/**
 * Purpose: An item specifying a class constructor method to be used in a ReportQuery's returned results.  
 * Example:
 *  ConstructorReportItem citem = new ConstructorReportItem("Employee");
 *  citem.setResultType(Employee.class);
 *  citem.addAttribute("firstName", employees.get("firstName"));
 *  query.addConstructorReportItem(citem);
 *  
 * when executed will return a collection of ReportQueryResults that contain Employee objects created using
 * the new Employee(firstname) method. 
 *
 * @author Chris Delahunt
 * @since TopLink Essentials
 */
public class ConstructorReportItem extends ReportItem  {

    protected Class[] constructorArgTypes;
    protected List constructorMappings;
    public List reportItems;
    
    public ConstructorReportItem() {
    }
    
  /**
   * Method to add an expression to be used to return the parameter that is then passed into the constructor method.
   * Similar to ReportQuery's addAttribute method, but a name is not needed
   * @param name - string used to look up this result in the ReportQueryResult
   */
    public ConstructorReportItem(String name) {
        super(name,null);
    }
    
  /**
   * Method to add an expression to be used to return the parameter that is then passed into the constructor method.
   * Similar to ReportQuery's addAttribute method, but a name is not needed
   * @param attributeExpression 
   */
    public void addAttribute( Expression attributeExpression) {
        ReportItem item = new ReportItem(getName()+getReportItems().size(), attributeExpression);
        getReportItems().add(item);
    }
    
    public void addAttribute(String attributeName, Expression attributeExpression, List joinedExpressions) {
        ReportItem item = new ReportItem(attributeName, attributeExpression);
        item.getJoinedAttributeManager().setJoinedAttributeExpressions_(joinedExpressions);
        getReportItems().add(item);
    }
    
    public void addItem(ReportItem item) {
        getReportItems().add(item);
    }
    
    public Class[] getConstructorArgTypes(){
        return constructorArgTypes;
    }

    public List getConstructorMappings(){
        return constructorMappings;
    }

    public List getReportItems(){
        if (reportItems==null){
            reportItems=new Vector();
        }
        return reportItems;
    }

    /**
     * INTERNAL:
     * Looks up mapping for attribute during preExecute of ReportQuery
     */
    public void initialize(ReportQuery query) throws QueryException {
        int size= getReportItems().size();
        List mappings = new Vector();
        for (int i=0;i [";
        //don't use getReportItems to avoid creating collection.  
        if (reportItems!=null){
            int size=reportItems.size();
            for(int i=0;i