/*
* JBoss, Home of Professional Open Source.
* See the COPYRIGHT.txt file distributed with this work for information
* regarding copyright ownership. Some portions may be licensed
* to Red Hat, Inc. under one or more contributor license agreements.
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*/
package org.teiid.cdk.api;
import java.io.IOException;
import java.net.URL;
import java.util.Collection;
import org.teiid.cdk.CommandBuilder;
import org.teiid.dqp.internal.datamgr.RuntimeMetadataImpl;
import org.teiid.language.Command;
import org.teiid.metadata.FunctionMethod;
import org.teiid.metadata.RuntimeMetadata;
import org.teiid.metadata.index.VDBMetadataFactory;
import org.teiid.query.function.FunctionLibrary;
import org.teiid.query.function.FunctionTree;
import org.teiid.query.function.SystemFunctionManager;
import org.teiid.query.function.UDFSource;
import org.teiid.query.metadata.BasicQueryMetadataWrapper;
import org.teiid.query.metadata.QueryMetadataInterface;
/**
* <p>This translation utility can be used to translate sql strings into
* Connector API language interfaces for testing purposes. The utility
* requires a metadata .vdb file in order to resolve references in
* the SQL.</p>
*
* <p>This utility class can also be used to obtain a RuntimeMetadata
* implementation based on the VDB file, which is sometimes handy when writing
* unit tests.</p>
*/
public class TranslationUtility {
private QueryMetadataInterface metadata;
/**
* Construct a utility instance with a given vdb file.
* @param vdbFile The .vdb file name representing metadata for the connector
*/
public TranslationUtility(String vdbFile) {
metadata = VDBMetadataFactory.getVDBMetadata(vdbFile);
}
public TranslationUtility(URL url) {
try {
metadata = VDBMetadataFactory.getVDBMetadata(url, null);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
public TranslationUtility(QueryMetadataInterface metadata) {
this.metadata = metadata;
}
public Command parseCommand(String sql, boolean generateAliases, boolean supportsGroupAliases) {
CommandBuilder commandBuilder = new CommandBuilder(metadata);
return commandBuilder.getCommand(sql, generateAliases, supportsGroupAliases);
}
/**
* Parse a SQL command and return an ICommand object.
* @param sql
* @return Command using the language interfaces
*/
public Command parseCommand(String sql) {
CommandBuilder commandBuilder = new CommandBuilder(metadata);
return commandBuilder.getCommand(sql);
}
/**
* Create a RuntimeMetadata that can be used for testing a connector.
* This RuntimeMetadata instance will be backed by the metadata from the vdbFile
* this translation utility instance was created with.
* @return RuntimeMetadata for testing
*/
public RuntimeMetadata createRuntimeMetadata() {
return new RuntimeMetadataImpl(metadata);
}
public void setUDF(final Collection<FunctionMethod> methods) {
this.metadata = new BasicQueryMetadataWrapper(this.metadata) {
@Override
public FunctionLibrary getFunctionLibrary() {
SystemFunctionManager sfm = new SystemFunctionManager();
return new FunctionLibrary(sfm.getSystemFunctions(), new FunctionTree("foo", new UDFSource(methods))); //$NON-NLS-1$
}
};
}
}