org.kuali.common.jdbc.suppliers
Class SqlLocationSupplier

java.lang.Object
  org.kuali.common.jdbc.suppliers.AbstractSupplier
      org.kuali.common.jdbc.suppliers.SqlLocationSupplier

All Implemented Interfaces:

Comparable<SqlSupplier>, SqlSupplier

public final class SqlLocationSupplier
extends AbstractSupplier
implements SqlSupplier

Supply SQL from a location containing nothing but SQL statements

Constructor Summary

SqlLocationSupplier(String location, SqlLocationContext context)

Method Summary

void	close() Close the supplier to free any resources it may have opened
SqlLocationContext	getContext()
String	getLocation()
SqlMetaData	getMetaData() Return SQL count and overall size
List<String>	getSql() Return a list of SQL statements to execute.
protected List<String>	getSqlList()
void	open() Open the supplier so it is ready to provide SQL

Methods inherited from class org.kuali.common.jdbc.suppliers.AbstractSupplier

compareTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

SqlLocationSupplier

public SqlLocationSupplier(String location,
                           SqlLocationContext context)

Method Detail

open

public void open()
          throws IOException

Description copied from interface: SqlSupplier

Open the supplier so it is ready to provide SQL

Specified by:

open in interface SqlSupplier

Throws:

IOException

getSql

public List<String> getSql()
                    throws IOException

Description copied from interface: SqlSupplier

Return a list of SQL statements to execute. Returns null when the SQL supply has been exhausted.

Specified by:

getSql in interface SqlSupplier

Throws:

IOException

close

public void close()

Description copied from interface: SqlSupplier

Close the supplier to free any resources it may have opened

Specified by:

close in interface SqlSupplier

getSqlList

protected List<String> getSqlList()
                           throws IOException

Throws:

IOException

getMetaData

public SqlMetaData getMetaData()

Description copied from interface: SqlSupplier

Return SQL count and overall size

Specified by:

getMetaData in interface SqlSupplier

getContext

public SqlLocationContext getContext()

getLocation

public String getLocation()