/*
// Licensed to Julian Hyde under one or more contributor license
// agreements. See the NOTICE file distributed with this work for
// additional information regarding copyright ownership.
//
// Julian Hyde licenses this file to you 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 net.hydromatic.optiq.jdbc;
import net.hydromatic.linq4j.Linq4j;
import net.hydromatic.linq4j.expressions.Expression;
import net.hydromatic.optiq.*;
import net.hydromatic.optiq.Table;
import net.hydromatic.optiq.impl.MaterializedViewTable;
import org.eigenbase.util.Pair;
import com.google.common.cache.*;
import com.google.common.collect.*;
import java.util.*;
/**
* Schema.
*
* <p>Wrapper around user-defined schema used internally.</p>
*/
public class OptiqSchema {
/** Comparator that compares all strings differently, but if two strings are
* equal in case-insensitive match they are right next to each other. In a
* collection sorted on this comparator, we can find case-insensitive matches
* for a given string using a range scan between the upper-case string and
* the lower-case string. */
private static final Comparator<String> COMPARATOR =
new Comparator<String>() {
public int compare(String o1, String o2) {
int c = o1.compareToIgnoreCase(o2);
if (c == 0) {
c = o1.compareTo(o2);
}
return c;
}
};
private final OptiqSchema parent;
public final Schema schema;
public final String name;
/** Tables explicitly defined in this schema. Does not include tables in
* {@link #schema}. */
public final NavigableMap<String, TableEntry> tableMap =
new TreeMap<String, TableEntry>(COMPARATOR);
private final Multimap<String, FunctionEntry> functionMap =
LinkedListMultimap.create();
private final NavigableSet<String> functionNames =
new TreeSet<String>(COMPARATOR);
private final NavigableMap<String, FunctionEntry> nullaryFunctionMap =
new TreeMap<String, FunctionEntry>(COMPARATOR);
private final NavigableMap<String, OptiqSchema> subSchemaMap =
new TreeMap<String, OptiqSchema>(COMPARATOR);
private ImmutableList<ImmutableList<String>> path;
private boolean cache = true;
private final Cached<SubSchemaCache> implicitSubSchemaCache;
private final Cached<ImmutableSortedSet<String>> implicitTableCache;
private final Cached<ImmutableSortedSet<String>> implicitFunctionCache;
public OptiqSchema(OptiqSchema parent, final Schema schema, String name) {
this.parent = parent;
this.schema = schema;
this.name = name;
assert (parent == null) == (this instanceof OptiqRootSchema);
this.implicitSubSchemaCache =
new AbstractCached<SubSchemaCache>() {
public SubSchemaCache build() {
return new SubSchemaCache(OptiqSchema.this,
ImmutableSortedSet.copyOf(COMPARATOR,
schema.getSubSchemaNames()));
}
};
this.implicitTableCache =
new AbstractCached<ImmutableSortedSet<String>>() {
public ImmutableSortedSet<String> build() {
return ImmutableSortedSet.copyOf(COMPARATOR,
schema.getTableNames());
}
};
this.implicitFunctionCache =
new AbstractCached<ImmutableSortedSet<String>>() {
public ImmutableSortedSet<String> build() {
return ImmutableSortedSet.copyOf(COMPARATOR,
schema.getFunctionNames());
}
};
}
/** Creates a root schema. When <code>addMetadataSchema</code> argument is
* true a "metadata" schema containing definitions of tables, columns etc. is
* added to root schema. */
public static OptiqRootSchema createRootSchema(boolean addMetadataSchema) {
OptiqRootSchema rootSchema =
new OptiqRootSchema(new OptiqConnectionImpl.RootSchema());
if (addMetadataSchema) {
rootSchema.add("metadata", MetadataSchema.INSTANCE);
}
return rootSchema;
}
/** Defines a table within this schema. */
public TableEntry add(String tableName, Table table) {
final TableEntryImpl entry =
new TableEntryImpl(this, tableName, table);
tableMap.put(tableName, entry);
return entry;
}
private FunctionEntry add(String name, Function function) {
final FunctionEntryImpl entry =
new FunctionEntryImpl(this, name, function);
functionMap.put(name, entry);
functionNames.add(name);
if (function.getParameters().isEmpty()) {
nullaryFunctionMap.put(name, entry);
}
return entry;
}
public OptiqRootSchema root() {
for (OptiqSchema schema = this;;) {
if (schema.parent == null) {
return (OptiqRootSchema) schema;
}
schema = schema.parent;
}
}
/** Returns the path of an object in this schema. */
public List<String> path(String name) {
final List<String> list = new ArrayList<String>();
if (name != null) {
list.add(name);
}
for (OptiqSchema s = this; s != null; s = s.parent) {
if (s.parent != null || !s.name.equals("")) {
// Omit the root schema's name from the path if it's the empty string,
// which it usually is.
list.add(s.name);
}
}
return ImmutableList.copyOf(Lists.reverse(list));
}
private void setCache(boolean cache) {
if (cache == this.cache) {
return;
}
final long now = System.currentTimeMillis();
implicitSubSchemaCache.enable(now, cache);
implicitTableCache.enable(now, cache);
implicitFunctionCache.enable(now, cache);
this.cache = cache;
}
public final OptiqSchema getSubSchema(String schemaName,
boolean caseSensitive) {
if (caseSensitive) {
// Check explicit schemas, case-sensitive.
final OptiqSchema entry = subSchemaMap.get(schemaName);
if (entry != null) {
return entry;
}
// Check implicit schemas, case-sensitive.
final long now = System.currentTimeMillis();
final SubSchemaCache subSchemaCache = implicitSubSchemaCache.get(now);
if (subSchemaCache.names.contains(schemaName)) {
return subSchemaCache.cache.getUnchecked(schemaName);
}
return null;
} else {
// Check explicit schemas, case-insensitive.
//noinspection LoopStatementThatDoesntLoop
for (Map.Entry<String, OptiqSchema> entry
: find(subSchemaMap, schemaName).entrySet()) {
return entry.getValue();
}
// Check implicit schemas, case-insensitive.
final long now = System.currentTimeMillis();
final SubSchemaCache subSchemaCache =
implicitSubSchemaCache.get(now);
final String schemaName2 = subSchemaCache.names.floor(schemaName);
if (schemaName2 != null) {
return subSchemaCache.cache.getUnchecked(schemaName2);
}
return null;
}
}
/** Adds a child schema of this schema. */
public OptiqSchema add(String name, Schema schema) {
final OptiqSchema optiqSchema = new OptiqSchema(this, schema, name);
subSchemaMap.put(name, optiqSchema);
return optiqSchema;
}
/** Returns a table with the given name. Does not look for views. */
public final Pair<String, Table> getTable(String tableName,
boolean caseSensitive) {
if (caseSensitive) {
// Check explicit tables, case-sensitive.
final TableEntry entry = tableMap.get(tableName);
if (entry != null) {
return Pair.of(tableName, entry.getTable());
}
// Check implicit tables, case-sensitive.
final long now = System.currentTimeMillis();
if (implicitTableCache.get(now).contains(tableName)) {
final Table table = schema.getTable(tableName);
if (table != null) {
return Pair.of(tableName, table);
}
}
return null;
} else {
// Check explicit tables, case-insensitive.
//noinspection LoopStatementThatDoesntLoop
for (Map.Entry<String, TableEntry> entry
: find(tableMap, tableName).entrySet()) {
return Pair.of(entry.getKey(), entry.getValue().getTable());
}
// Check implicit tables, case-insensitive.
final long now = System.currentTimeMillis();
final NavigableSet<String> implicitTableNames =
implicitTableCache.get(now);
final String tableName2 = implicitTableNames.floor(tableName);
if (tableName2 != null) {
final Table table = schema.getTable(tableName2);
if (table != null) {
return Pair.of(tableName2, table);
}
}
return null;
}
}
public String getName() {
return name;
}
public SchemaPlus plus() {
return new SchemaPlusImpl();
}
public static OptiqSchema from(SchemaPlus plus) {
return ((SchemaPlusImpl) plus).optiqSchema();
}
/** Returns the default path resolving functions from this schema.
*
* <p>The path consists is a list of lists of strings.
* Each list of strings represents the path of a schema from the root schema.
* For example, [[], [foo], [foo, bar, baz]] represents three schemas: the
* root schema "/" (level 0), "/foo" (level 1) and "/foo/bar/baz" (level 3).
*
* @return Path of this schema; never null, may be empty
*/
public List<? extends List<String>> getPath() {
if (path != null) {
return path;
}
// Return a path consisting of just this schema.
return ImmutableList.of(path(null));
}
/** Returns a collection of sub-schemas, both explicit (defined using
* {@link #add(String, net.hydromatic.optiq.Schema)}) and implicit
* (defined using {@link net.hydromatic.optiq.Schema#getSubSchemaNames()}
* and {@link Schema#getSubSchema(String)}). */
public NavigableMap<String, OptiqSchema> getSubSchemaMap() {
// Build a map of implicit sub-schemas first, then explicit sub-schemas.
// If there are implicit and explicit with the same name, explicit wins.
final ImmutableSortedMap.Builder<String, OptiqSchema> builder =
new ImmutableSortedMap.Builder<String, OptiqSchema>(COMPARATOR);
final long now = System.currentTimeMillis();
final SubSchemaCache subSchemaCache = implicitSubSchemaCache.get(now);
for (String name : subSchemaCache.names) {
builder.put(name, subSchemaCache.cache.getUnchecked(name));
}
builder.putAll(subSchemaMap);
return builder.build();
}
/** Returns the set of all table names. Includes implicit and explicit tables
* and functions with zero parameters. */
public NavigableSet<String> getTableNames() {
final ImmutableSortedSet.Builder<String> builder =
new ImmutableSortedSet.Builder<String>(COMPARATOR);
// Add explicit tables, case-sensitive.
builder.addAll(tableMap.keySet());
// Add implicit tables, case-sensitive.
builder.addAll(implicitTableCache.get(System.currentTimeMillis()));
return builder.build();
}
/** Returns a collection of all functions, explicit and implicit, with a given
* name. Never null. */
public Collection<Function> getFunctions(String name, boolean caseSensitive) {
final ImmutableList.Builder<Function> builder = ImmutableList.builder();
if (caseSensitive) {
// Add explicit functions, case-sensitive.
final Collection<FunctionEntry> functionEntries = functionMap.get(name);
if (functionEntries != null) {
for (FunctionEntry functionEntry : functionEntries) {
builder.add(functionEntry.getFunction());
}
}
// Add implicit functions, case-sensitive.
final Collection<Function> functions = schema.getFunctions(name);
if (functions != null) {
builder.addAll(functions);
}
} else {
// Add explicit functions, case-insensitive.
for (String name2 : find(functionNames, name)) {
final Collection<FunctionEntry> functionEntries =
functionMap.get(name2);
if (functionEntries != null) {
for (FunctionEntry functionEntry : functionEntries) {
builder.add(functionEntry.getFunction());
}
}
}
// Add implicit functions, case-insensitive.
for (String name2
: find(implicitFunctionCache.get(System.currentTimeMillis()), name)) {
final Collection<Function> functions = schema.getFunctions(name2);
if (functions != null) {
builder.addAll(functions);
}
}
}
return builder.build();
}
/** Returns the list of function names in this schema, both implicit and
* explicit, never null. */
public NavigableSet<String> getFunctionNames() {
final ImmutableSortedSet.Builder<String> builder =
new ImmutableSortedSet.Builder<String>(COMPARATOR);
// Add explicit functions, case-sensitive.
builder.addAll(functionMap.keySet());
// Add implicit functions, case-sensitive.
builder.addAll(implicitFunctionCache.get(System.currentTimeMillis()));
return builder.build();
}
/** Returns tables derived from explicit and implicit functions
* that take zero parameters. */
public NavigableMap<String, Table> getTablesBasedOnNullaryFunctions() {
ImmutableSortedMap.Builder<String, Table> builder =
new ImmutableSortedMap.Builder<String, Table>(COMPARATOR);
for (Map.Entry<String, FunctionEntry> s : nullaryFunctionMap.entrySet()) {
final Function function = s.getValue().getFunction();
if (function instanceof TableMacro) {
assert function.getParameters().isEmpty();
final Table table = ((TableMacro) function).apply(ImmutableList.of());
builder.put(s.getKey(), table);
}
}
for (String s : implicitFunctionCache.get(System.currentTimeMillis())) {
for (Function function : schema.getFunctions(s)) {
if (function instanceof TableMacro
&& function.getParameters().isEmpty()) {
final Table table = ((TableMacro) function).apply(ImmutableList.of());
builder.put(s, table);
}
}
}
return builder.build();
}
/** Returns a tables derived from explicit and implicit functions
* that take zero parameters. */
public Pair<String, Table> getTableBasedOnNullaryFunction(String tableName,
boolean caseSensitive) {
if (caseSensitive) {
final FunctionEntry functionEntry = nullaryFunctionMap.get(tableName);
if (functionEntry != null) {
final Function function = functionEntry.getFunction();
if (function instanceof TableMacro) {
assert function.getParameters().isEmpty();
final Table table = ((TableMacro) function).apply(ImmutableList.of());
return Pair.of(tableName, table);
}
}
for (Function function : schema.getFunctions(tableName)) {
if (function instanceof TableMacro
&& function.getParameters().isEmpty()) {
final Table table = ((TableMacro) function).apply(ImmutableList.of());
return Pair.of(tableName, table);
}
}
} else {
for (Map.Entry<String, FunctionEntry> entry
: find(nullaryFunctionMap, tableName).entrySet()) {
final Function function = entry.getValue().getFunction();
if (function instanceof TableMacro) {
assert function.getParameters().isEmpty();
final Table table = ((TableMacro) function).apply(ImmutableList.of());
return Pair.of(entry.getKey(), table);
}
}
final NavigableSet<String> set =
implicitFunctionCache.get(System.currentTimeMillis());
for (String s : find(set, tableName)) {
for (Function function : schema.getFunctions(s)) {
if (function instanceof TableMacro
&& function.getParameters().isEmpty()) {
final Table table =
((TableMacro) function).apply(ImmutableList.of());
return Pair.of(s, table);
}
}
}
}
return null;
}
/** Returns a subset of a map whose keys match the given string
* case-insensitively. */
private static <V> NavigableMap<String, V> find(NavigableMap<String, V> map,
String s) {
assert map.comparator() == COMPARATOR;
return map.subMap(s.toUpperCase(), true, s.toLowerCase(), true);
}
/** Returns a subset of a set whose values match the given string
* case-insensitively. */
private static Iterable<String> find(NavigableSet<String> set, String name) {
assert set.comparator() == COMPARATOR;
return set.subSet(name.toUpperCase(), true, name.toLowerCase(), true);
}
/**
* Entry in a schema, such as a table or sub-schema.
*
* <p>Each object's name is a property of its membership in a schema;
* therefore in principle it could belong to several schemas, or
* even the same schema several times, with different names. In this
* respect, it is like an inode in a Unix file system.</p>
*
* <p>The members of a schema must have unique names.
*/
public abstract static class Entry {
public final OptiqSchema schema;
public final String name;
public Entry(OptiqSchema schema, String name) {
Linq4j.requireNonNull(schema);
Linq4j.requireNonNull(name);
this.schema = schema;
this.name = name;
}
/** Returns this object's path. For example ["hr", "emps"]. */
public final List<String> path() {
return schema.path(name);
}
}
/** Membership of a table in a schema. */
public abstract static class TableEntry extends Entry {
public TableEntry(OptiqSchema schema, String name) {
super(schema, name);
}
public abstract Table getTable();
}
/** Membership of a function in a schema. */
public abstract static class FunctionEntry extends Entry {
public FunctionEntry(OptiqSchema schema, String name) {
super(schema, name);
}
public abstract Function getFunction();
/** Whether this represents a materialized view. (At a given point in time,
* it may or may not be materialized as a table.) */
public abstract boolean isMaterialization();
}
/** Implementation of {@link SchemaPlus} based on an {@code OptiqSchema}. */
private class SchemaPlusImpl implements SchemaPlus {
public OptiqSchema optiqSchema() {
return OptiqSchema.this;
}
public SchemaPlus getParentSchema() {
return parent == null ? null : parent.plus();
}
public String getName() {
return OptiqSchema.this.getName();
}
public boolean isMutable() {
return schema.isMutable();
}
public void setCacheEnabled(boolean cache) {
OptiqSchema.this.setCache(cache);
}
public boolean isCacheEnabled() {
return OptiqSchema.this.cache;
}
public boolean contentsHaveChangedSince(long lastCheck, long now) {
return schema.contentsHaveChangedSince(lastCheck, now);
}
public Expression getExpression(SchemaPlus parentSchema, String name) {
return schema.getExpression(parentSchema, name);
}
public Table getTable(String name) {
final Pair<String, Table> pair = OptiqSchema.this.getTable(name, true);
return pair == null ? null : pair.getValue();
}
public NavigableSet<String> getTableNames() {
return OptiqSchema.this.getTableNames();
}
public Collection<Function> getFunctions(String name) {
return OptiqSchema.this.getFunctions(name, true);
}
public NavigableSet<String> getFunctionNames() {
return OptiqSchema.this.getFunctionNames();
}
public SchemaPlus getSubSchema(String name) {
final OptiqSchema subSchema = OptiqSchema.this.getSubSchema(name, true);
return subSchema == null ? null : subSchema.plus();
}
public Set<String> getSubSchemaNames() {
return OptiqSchema.this.getSubSchemaMap().keySet();
}
public SchemaPlus add(String name, Schema schema) {
final OptiqSchema optiqSchema = OptiqSchema.this.add(name, schema);
return optiqSchema.plus();
}
public <T> T unwrap(Class<T> clazz) {
if (clazz.isInstance(this)) {
return clazz.cast(this);
}
if (clazz.isInstance(OptiqSchema.this)) {
return clazz.cast(OptiqSchema.this);
}
if (clazz.isInstance(OptiqSchema.this.schema)) {
return clazz.cast(OptiqSchema.this.schema);
}
throw new ClassCastException("not a " + clazz);
}
public void setPath(ImmutableList<ImmutableList<String>> path) {
OptiqSchema.this.path = path;
}
public void add(String name, Table table) {
OptiqSchema.this.add(name, table);
}
public void add(String name, net.hydromatic.optiq.Function function) {
OptiqSchema.this.add(name, function);
}
}
/**
* Implementation of {@link net.hydromatic.optiq.jdbc.OptiqSchema.TableEntry}
* where all properties are held in fields.
*/
public static class TableEntryImpl extends TableEntry {
private final Table table;
/** Creates a TableEntryImpl. */
public TableEntryImpl(OptiqSchema schema, String name, Table table) {
super(schema, name);
assert table != null;
this.table = table;
}
public Table getTable() {
return table;
}
}
/**
* Implementation of {@link FunctionEntry}
* where all properties are held in fields.
*/
public static class FunctionEntryImpl extends FunctionEntry {
private final Function function;
/** Creates a FunctionEntryImpl. */
public FunctionEntryImpl(OptiqSchema schema, String name,
Function function) {
super(schema, name);
this.function = function;
}
public Function getFunction() {
return function;
}
public boolean isMaterialization() {
return function
instanceof MaterializedViewTable.MaterializedViewTableMacro;
}
}
/** Strategy for caching the value of an object and re-creating it if its
* value is out of date as of a given timestamp.
*
* @param <T> Type of cached object
*/
private interface Cached<T> {
/** Returns the value; uses cached value if valid. */
T get(long now);
/** Creates a new value. */
T build();
/** Called when OptiqSchema caching is enabled or disabled. */
void enable(long now, boolean enabled);
}
/** Implementation of {@link net.hydromatic.optiq.jdbc.OptiqSchema.Cached}
* that drives from {@link net.hydromatic.optiq.jdbc.OptiqSchema#cache}. */
private abstract class AbstractCached<T> implements Cached<T> {
T t;
long checked = Long.MIN_VALUE;
public T get(long now) {
if (!OptiqSchema.this.cache) {
return build();
}
if (checked == Long.MIN_VALUE
|| schema.contentsHaveChangedSince(checked, now)) {
t = build();
}
checked = now;
return t;
}
public void enable(long now, boolean enabled) {
if (!enabled) {
t = null;
}
checked = Long.MIN_VALUE;
}
}
/** Information about the implicit sub-schemas of an {@link OptiqSchema}. */
private static class SubSchemaCache {
/** The names of sub-schemas returned from the {@link Schema} SPI. */
final ImmutableSortedSet<String> names;
/** Cached {@link net.hydromatic.optiq.jdbc.OptiqSchema} wrappers. It is
* worth caching them because they contain maps of their own sub-objects. */
final LoadingCache<String, OptiqSchema> cache;
private SubSchemaCache(final OptiqSchema optiqSchema,
ImmutableSortedSet<String> names) {
this.names = names;
this.cache = CacheBuilder.newBuilder().build(
new CacheLoader<String, OptiqSchema>() {
@SuppressWarnings("NullableProblems")
@Override public OptiqSchema load(String schemaName) {
final Schema subSchema =
optiqSchema.schema.getSubSchema(schemaName);
if (subSchema == null) {
throw new RuntimeException("sub-schema " + schemaName
+ " not found");
}
return new OptiqSchema(optiqSchema, subSchema, schemaName);
}
});
}
}
}
// End OptiqSchema.java