aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/com/healthmarketscience/jackcess/util/Joiner.java
diff options
context:
space:
mode:
authorJames Ahlborn <jtahlborn@yahoo.com>2013-08-16 02:09:48 +0000
committerJames Ahlborn <jtahlborn@yahoo.com>2013-08-16 02:09:48 +0000
commit417fb06208f50cbf164a1c101ac03c7bae0856d8 (patch)
tree52217c1c09bc71377ca0f422ed43d24d6917a178 /src/java/com/healthmarketscience/jackcess/util/Joiner.java
parent790b943d773fc72a11089b6acaf17aa341f92ae4 (diff)
downloadjackcess-417fb06208f50cbf164a1c101ac03c7bae0856d8.tar.gz
jackcess-417fb06208f50cbf164a1c101ac03c7bae0856d8.zip
move files into standard maven dir structure
git-svn-id: https://svn.code.sf.net/p/jackcess/code/jackcess/trunk@781 f203690c-595d-4dc9-a70b-905162fa7fd2
Diffstat (limited to 'src/java/com/healthmarketscience/jackcess/util/Joiner.java')
-rw-r--r--src/java/com/healthmarketscience/jackcess/util/Joiner.java298
1 files changed, 0 insertions, 298 deletions
diff --git a/src/java/com/healthmarketscience/jackcess/util/Joiner.java b/src/java/com/healthmarketscience/jackcess/util/Joiner.java
deleted file mode 100644
index 65f6441..0000000
--- a/src/java/com/healthmarketscience/jackcess/util/Joiner.java
+++ /dev/null
@@ -1,298 +0,0 @@
-/*
-Copyright (c) 2011 James Ahlborn
-
-This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public
-License as published by the Free Software Foundation; either
-version 2.1 of the License, or (at your option) any later version.
-
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public
-License along with this library; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-USA
-*/
-
-package com.healthmarketscience.jackcess.util;
-
-import java.io.IOException;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-
-import com.healthmarketscience.jackcess.CursorBuilder;
-import com.healthmarketscience.jackcess.Index;
-import com.healthmarketscience.jackcess.IndexCursor;
-import com.healthmarketscience.jackcess.Row;
-import com.healthmarketscience.jackcess.Table;
-import com.healthmarketscience.jackcess.impl.IndexImpl;
-
-/**
- * Utility for finding rows based on pre-defined, foreign-key table
- * relationships.
- *
- * @author James Ahlborn
- * @usage _general_class_
- */
-public class Joiner
-{
- private final Index _fromIndex;
- private final List<? extends Index.Column> _fromCols;
- private final IndexCursor _toCursor;
- private final Object[] _entryValues;
-
- private Joiner(Index fromIndex, IndexCursor toCursor)
- {
- _fromIndex = fromIndex;
- _fromCols = _fromIndex.getColumns();
- _entryValues = new Object[_fromCols.size()];
- _toCursor = toCursor;
- }
-
- /**
- * Creates a new Joiner based on the foreign-key relationship between the
- * given "from"" table and the given "to"" table.
- *
- * @param fromTable the "from" side of the relationship
- * @param toTable the "to" side of the relationship
- * @throws IllegalArgumentException if there is no relationship between the
- * given tables
- */
- public static Joiner create(Table fromTable, Table toTable)
- throws IOException
- {
- return create(fromTable.getForeignKeyIndex(toTable));
- }
-
- /**
- * Creates a new Joiner based on the given index which backs a foreign-key
- * relationship. The table of the given index will be the "from" table and
- * the table on the other end of the relationship will be the "to" table.
- *
- * @param fromIndex the index backing one side of a foreign-key relationship
- */
- public static Joiner create(Index fromIndex)
- throws IOException
- {
- Index toIndex = fromIndex.getReferencedIndex();
- IndexCursor toCursor = CursorBuilder.createCursor(toIndex);
- // text lookups are always case-insensitive
- toCursor.setColumnMatcher(CaseInsensitiveColumnMatcher.INSTANCE);
- return new Joiner(fromIndex, toCursor);
- }
-
- /**
- * Creates a new Joiner that is the reverse of this Joiner (the "from" and
- * "to" tables are swapped).
- */
- public Joiner createReverse()
- throws IOException
- {
- return create(getToTable(), getFromTable());
- }
-
- public Table getFromTable() {
- return getFromIndex().getTable();
- }
-
- public Index getFromIndex() {
- return _fromIndex;
- }
-
- public Table getToTable() {
- return getToCursor().getTable();
- }
-
- public Index getToIndex() {
- return getToCursor().getIndex();
- }
-
- public IndexCursor getToCursor() {
- return _toCursor;
- }
-
- public List<? extends Index.Column> getColumns() {
- // note, this list is already unmodifiable, no need to re-wrap
- return _fromCols;
- }
-
- /**
- * Returns {@code true} if the "to" table has any rows based on the given
- * columns in the "from" table, {@code false} otherwise.
- */
- public boolean hasRows(Map<String,?> fromRow) throws IOException {
- toEntryValues(fromRow);
- return _toCursor.findFirstRowByEntry(_entryValues);
- }
-
- /**
- * Returns {@code true} if the "to" table has any rows based on the given
- * columns in the "from" table, {@code false} otherwise.
- * @usage _intermediate_method_
- */
- public boolean hasRows(Object[] fromRow) throws IOException {
- toEntryValues(fromRow);
- return _toCursor.findFirstRowByEntry(_entryValues);
- }
-
- /**
- * Returns the first row in the "to" table based on the given columns in the
- * "from" table if any, {@code null} if there is no matching row.
- *
- * @param fromRow row from the "from" table (which must include the relevant
- * columns for this join relationship)
- */
- public Row findFirstRow(Map<String,?> fromRow)
- throws IOException
- {
- return findFirstRow(fromRow, null);
- }
-
- /**
- * Returns selected columns from the first row in the "to" table based on
- * the given columns in the "from" table if any, {@code null} if there is no
- * matching row.
- *
- * @param fromRow row from the "from" table (which must include the relevant
- * columns for this join relationship)
- * @param columnNames desired columns in the from table row
- */
- public Row findFirstRow(Map<String,?> fromRow, Collection<String> columnNames)
- throws IOException
- {
- return (hasRows(fromRow) ? _toCursor.getCurrentRow(columnNames) : null);
- }
-
- /**
- * Returns an Iterator over all the rows in the "to" table based on the
- * given columns in the "from" table.
- *
- * @param fromRow row from the "from" table (which must include the relevant
- * columns for this join relationship)
- */
- public EntryIterableBuilder findRows(Map<String,?> fromRow)
- {
- toEntryValues(fromRow);
- return _toCursor.newEntryIterable(_entryValues);
- }
-
- /**
- * Returns an Iterator with the selected columns over all the rows in the
- * "to" table based on the given columns in the "from" table.
- *
- * @param fromRow row from the "from" table (which must include the relevant
- * columns for this join relationship)
- */
- public EntryIterableBuilder findRows(Object[] fromRow)
- {
- toEntryValues(fromRow);
- return _toCursor.newEntryIterable(_entryValues);
- }
-
- /**
- * Deletes any rows in the "to" table based on the given columns in the
- * "from" table.
- *
- * @param fromRow row from the "from" table (which must include the relevant
- * columns for this join relationship)
- * @return {@code true} if any "to" rows were deleted, {@code false}
- * otherwise
- */
- public boolean deleteRows(Map<String,?> fromRow) throws IOException {
- return deleteRowsImpl(findRows(fromRow)
- .setColumnNames(Collections.<String>emptySet())
- .iterator());
- }
-
- /**
- * Deletes any rows in the "to" table based on the given columns in the
- * "from" table.
- *
- * @param fromRow row from the "from" table (which must include the relevant
- * columns for this join relationship)
- * @return {@code true} if any "to" rows were deleted, {@code false}
- * otherwise
- * @usage _intermediate_method_
- */
- public boolean deleteRows(Object[] fromRow) throws IOException {
- return deleteRowsImpl(findRows(fromRow)
- .setColumnNames(Collections.<String>emptySet())
- .iterator());
- }
-
- /**
- * Deletes all the rows and returns whether or not any "to"" rows were
- * deleted.
- */
- private static boolean deleteRowsImpl(Iterator<Row> iter)
- throws IOException
- {
- boolean removed = false;
- while(iter.hasNext()) {
- iter.next();
- iter.remove();
- removed = true;
- }
- return removed;
- }
-
- /**
- * Fills in the _entryValues with the relevant info from the given "from"
- * table row.
- */
- private void toEntryValues(Map<String,?> fromRow) {
- for(int i = 0; i < _entryValues.length; ++i) {
- _entryValues[i] = _fromCols.get(i).getColumn().getRowValue(fromRow);
- }
- }
-
- /**
- * Fills in the _entryValues with the relevant info from the given "from"
- * table row.
- */
- private void toEntryValues(Object[] fromRow) {
- for(int i = 0; i < _entryValues.length; ++i) {
- _entryValues[i] = _fromCols.get(i).getColumn().getRowValue(fromRow);
- }
- }
-
- /**
- * Returns a pretty string describing the foreign key relationship backing
- * this Joiner.
- */
- public String toFKString() {
- StringBuilder sb = new StringBuilder();
- sb.append("Foreign Key from ");
-
- String fromType = "] (primary)";
- String toType = "] (secondary)";
- if(!((IndexImpl)_fromIndex).getReference().isPrimaryTable()) {
- fromType = "] (secondary)";
- toType = "] (primary)";
- }
-
- sb.append(getFromTable().getName()).append("[");
-
- sb.append(_fromCols.get(0).getName());
- for(int i = 1; i < _fromCols.size(); ++i) {
- sb.append(",").append(_fromCols.get(i).getName());
- }
- sb.append(fromType);
-
- sb.append(" to ").append(getToTable().getName()).append("[");
- List<? extends Index.Column> toCols = _toCursor.getIndex().getColumns();
- sb.append(toCols.get(0).getName());
- for(int i = 1; i < toCols.size(); ++i) {
- sb.append(",").append(toCols.get(i).getName());
- }
- sb.append(toType);
-
- return sb.toString();
- }
-}