nz.co.gregs.dbvolution.DBQueryRow Maven / Gradle / Ivy
/*
* Copyright 2013 Gregory Graham.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package nz.co.gregs.dbvolution;
import nz.co.gregs.dbvolution.datatypes.QueryableDatatype;
import java.io.PrintStream;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import nz.co.gregs.dbvolution.internal.query.QueryDetails;
/**
* Contains all the instances of DBRow that are associated with one line of a
* DBQuery request.
*
*
* DBQueryRow represents an individual line within the results of a query.
* However the results within the line are contained in instances of all the
* DBRow subclasses included in the DBQuery.
*
*
* Each instance is accessible thru the
* {@link #get(nz.co.gregs.dbvolution.DBRow) get(DBRow) method}.
*
*
Support DBvolution at
* Patreon
*
* @author Gregory Graham
*
*/
public class DBQueryRow extends HashMap, DBRow> {
private static final long serialVersionUID = 1;
private final Map> expressionColumnValues = new LinkedHashMap<>();
private transient final QueryDetails baseQuery;
public DBQueryRow(QueryDetails queryThatThisRowWasGeneratedFor) {
super();
baseQuery = queryThatThisRowWasGeneratedFor;
}
DBQueryRow() {
throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
}
/**
* Returns the instance of exemplar contained within this DBQueryRow.
*
*
* Finds the instance of the class supplied that is relevant to the DBRow and
* returns it.
*
*
* If the exemplar represents an optional table an there were no appropriate
* rows found for that table then NULL will be returned.
*
*
* Criteria set on the exemplar are ignored.
*
*
* For example: Marque thisMarque = myQueryRow.get(new Marque());
*
* @param DBRow type
* @param exemplar exemplar
* Support DBvolution at
* Patreon
* @return the instance of exemplar that is in the DBQueryRow instance
*/
@SuppressWarnings("unchecked")
public E get(E exemplar) {
return (E) get(exemplar.getClass());
}
/**
* Returns the all DBRow instances contained within this DBQueryRow.
*
* Support DBvolution at
* Patreon
*
* @return all DBRow instances that are in this DBQueryRow instance
*/
public List getAll() {
final ArrayList arrayList = new ArrayList<>();
arrayList.addAll(this.values());
return arrayList;
}
/**
* Print the specified columns to the specified PrintStream as one line.
*
* @param ps ps
* @param columns columns
*/
public void print(PrintStream ps, QueryableDatatype... columns) {
for (QueryableDatatype qdt : columns) {
ps.print("" + qdt + " ");
}
ps.println();
}
/**
* Print the all columns to the specified PrintStream as one line.
*
* @param ps ps
*/
public void print(PrintStream ps) {
for (DBRow row : values()) {
ps.print("" + row);
}
}
public void addExpressionColumnValue(Object key, QueryableDatatype expressionQDT) {
expressionColumnValues.put(key, expressionQDT);
}
public QueryableDatatype getExpressionColumnValue(Object key) {
return expressionColumnValues.get(key);
}
/**
* Returns all the fields names from all the DBRow types in the DBQueryRow.
*
*
* This is essentially a list of all the columns returned from the database
* query.
*
*
* Column data may not have been populated.
*
*
* Please note this is a crude instrument for accessing the data in this
* DBQueryRow. You should probably be using {@link DBQueryRow#get(nz.co.gregs.dbvolution.DBRow)
* } and using the fields and methods of the individual DBRow classes.
*
*
Support DBvolution at
* Patreon
*
* @return a list of field names.
*/
public List getFieldNames() {
List returnList = new ArrayList();
for (DBRow tab : baseQuery.getAllQueryTables()) {
Collection fieldNames = tab.getFieldNames();
for (String fieldName : fieldNames) {
returnList.add(tab.getClass().getSimpleName() + ":" + fieldName);
}
}
return returnList;
}
/**
* Returns all the fields values from all the DBRow types in the DBQueryRow.
*
*
* This is essentially a list of all the values returned from the database
* query.
*
*
* Please note this is a crude instrument for accessing the data in this
* DBQueryRow. You should probably be using {@link DBQueryRow#get(nz.co.gregs.dbvolution.DBRow)
* } and using the fields and methods of the individual DBRow classes.
*
* @param dateFormat format that date should be formatted to.
*
Support DBvolution at
* Patreon
* @return a list of field names.
*
*/
public List getFieldValues(SimpleDateFormat dateFormat) {
List returnList = new ArrayList();
for (DBRow tab : baseQuery.getAllQueryTables()) {
DBRow actualRow = this.get(tab);
if (actualRow != null) {
returnList.addAll(actualRow.getFieldValues(dateFormat));
} else {
for (String returnList1 : tab.getFieldNames()) {
returnList.add("");
}
}
}
return returnList;
}
/**
* Convenience method to convert this DBQueryRow into a CSV or TSV type
* header.
*
*
* The line separator is not included in the results, to allow for portability
* and post-processing.
*
* @param separatorToUseBetweenValues separatorToUseBetweenValues
*
Support DBvolution at
* Patreon
* @return a list of all the fields in the DBQueryRow separated by the
* supplied value
*/
public String toSeparatedHeader(String separatorToUseBetweenValues) {
StringBuilder returnStr = new StringBuilder();
String separator = "";
List fieldNames = this.getFieldNames();
for (String fieldName : fieldNames) {
returnStr.append(separator).append("\"").append(fieldName.replaceAll("\"", "\"\"")).append("\"");
separator = separatorToUseBetweenValues;
}
return returnStr.toString();
}
/**
* Convenience method to convert this DBQueryRow into a CSV or TSV type line.
*
*
* The line separator is not included in the results, to allow for portability
* and post-processing.
*
* @param separatorToUseBetweenValues separatorToUseBetweenValues
*
Support DBvolution at
* Patreon
* @return a list of all the values in the DBQueryRow formatted for a TSV or
* CSV file
*/
public String toSeparatedLine(String separatorToUseBetweenValues) {
return toSeparatedLine(separatorToUseBetweenValues, null);
}
/**
* Convenience method to convert this DBQueryRow into a CSV or TSV type line.
*
*
* The line separator is not included in the results, to allow for portability
* and post-processing.
*
* @param separatorToUseBetweenValues separatorToUseBetweenValues
* @param dateFormat format that dates should be formatted to.
*
Support DBvolution at
* Patreon
* @return a list of all the values in the DBQueryRow formatted for a TSV or
* CSV file
*/
public String toSeparatedLine(String separatorToUseBetweenValues, SimpleDateFormat dateFormat) {
StringBuilder returnStr = new StringBuilder();
String separator = "";
List fieldValues = this.getFieldValues(dateFormat);
for (String fieldValue : fieldValues) {
returnStr.append(separator).append("\"").append(fieldValue.replaceAll("\"", "\"\"")).append("\"");
separator = separatorToUseBetweenValues;
}
return returnStr.toString();
}
/**
* Convenience method to convert this DBQueryRow into a CSV file's header.
*
*
* The line separator is not included in the results, to allow for portability
* and post-processing.
*
*
Support DBvolution at
* Patreon
*
* @return a list of all the fields in the DBQueryRow formatted for a CSV file
*/
public String toCSVHeader() {
return toSeparatedHeader(",");
}
/**
* Convenience method to convert this DBQueryRow into a CSV line.
*
*
* The line separator is not included in the results, to allow for portability
* and post-processing.
*
*
Support DBvolution at
* Patreon
*
* @return a list of all the values in the DBQueryRow formatted for a CSV file
*/
public String toCSVLine() {
return toSeparatedLine(",");
}
/**
* Convenience method to convert this DBQueryRow into a CSV line.
*
*
* The line separator is not included in the results, to allow for portability
* and post-processing.
*
* @param dateFormat dateFormat
*
Support DBvolution at
* Patreon
* @return a list of all the values in the DBQueryRow formatted for a CSV file
*/
public String toCSVLine(SimpleDateFormat dateFormat) {
return toSeparatedLine(",", dateFormat);
}
/**
* Convenience method to convert this DBQueryRow into a Tab Separated Values
* file's header.
*
*
* The line separator is not included in the results, to allow for portability
* and post-processing.
*
*
Support DBvolution at
* Patreon
*
* @return a list of all the fields in the DBQueryRow formatted for a TSV file
*/
public String toTabbedHeader() {
return toSeparatedHeader("\t");
}
/**
* Convenience method to convert this DBQueryRow into a Tab Separated Values
* line.
*
* The line separator is not included in the results, to allow for portability
* and post-processing.
*
*
Support DBvolution at
* Patreon
*
* @return a list of all the values in the DBQueryRow formatted for a TSV file
* @throws java.lang.IllegalAccessException java.lang.IllegalAccessException
*
*/
public String toTabbedLine() throws IllegalArgumentException, IllegalAccessException {
return toSeparatedLine("\t");
}
@Override
public DBQueryRow clone() {
return (DBQueryRow) super.clone(); //To change body of generated methods, choose Tools | Templates.
}
}