com.sas.iquery.metadata.business
Interface Export

public interface Export

Method Summary

abstract com.sas.iquery.metadata.business.CreateTableDataSelection	createTableDataSelection(DataSelection selection, com.sas.iquery.strategies.sas.oma.AbstractStrategy strategy)
abstract Export	engine(java.lang.String engine) Engine name specified when exporting to SAS library
abstract java.lang.String	generate() This method generates the ResultSet/Export code and returns a String containing the generated code.
abstract java.lang.String	generate(java.lang.String tableName) This method generates the ResultSet/Export code based on a caller-defined tableName and returns a String containing the generated code.
abstract java.lang.StringBuffer	generateExportStatementForCSV(java.lang.String inputTable)
abstract java.lang.StringBuffer	generateJSONStatement(java.lang.String inputTable)
abstract java.lang.StringBuffer	generateLasrStatement()
abstract java.lang.StringBuffer	generateLasrStatement(java.lang.String inputTable)
abstract java.lang.StringBuffer	generateProcMetalib(java.lang.String inputTable)
abstract java.lang.String	generateUdfStatement()
abstract int	getColumnLimit()
abstract ExportSelectionMetadata	getExportMetadata() The metadata to be exported (ie the metadata about what is to be exported).
abstract com.sas.iquery.metadata.business.ExportProperties[]	getExportProperties()
abstract boolean	getIgnoreReachThruTable()
abstract boolean	getIncludeAllColumns()
abstract com.sas.iquery.metadata.business.DataSourceTable	getlasrDataSourceTable()
abstract java.lang.String	getLasrFormatLibnameStmt()
abstract java.lang.String	getLasrFormatLibref()
abstract boolean	getOnlyReferencedUDFs()
abstract java.lang.String	getResultSetTableName()
abstract com.sas.iquery.metadata.physical.SASLibrary	getSASLibrary()
abstract int	getTableLimit()
abstract java.lang.String	getUdfOutputTableLibref()
abstract java.lang.String	getUdfOutputTableName()
abstract ExportUploadMetadata	getUploadMetadata() The metadata to be uploaded (ie the metadata about the query to upload).
abstract com.sas.iquery.metadata.business.ExportType	getUsage()
abstract Export	ignoreReachThruTable(boolean ignoreReachThruTable) A boolean indicating whether the reach thru table should be ignored and all of the joined star schema tables should be returned.
abstract Export	includeAllColumns(boolean includeAllColumns) A boolean indicating whether only the all columns should be included from the based tables.
abstract boolean	isAllDetail()
abstract boolean	isCreateTableRequiredForExport()
abstract boolean	isDetailWithFilters()
abstract boolean	isMetalibInEffect()
abstract boolean	isTableOnly()
abstract boolean	isTooManyTablesOrColumns()
abstract boolean	isViewOnly()
abstract Export	JSONExportOptions(java.lang.String JSONExportOptions, java.lang.String JSONExportTablename) JSON Export options
abstract Export	JSONOptions(java.lang.String JSONOptions) JSON options
abstract Export	JSONout(java.lang.String JSONout) Filename for JSON when exporting to JSON file
abstract Export	lasrAdd() For adding a table to LASR using an existing server
abstract Export	lasrCreate() proc lasr Create option without a table
abstract Export	lasrCreate(java.lang.String createFile) File used on Create for proc lasr
abstract Export	lasrData(java.lang.String data) Used when exporting a single Table based on a String
abstract Export	lasrData(com.sas.iquery.metadata.physical.Table table) Used when exporting a single table from a Table object
abstract Export	lasrFormatLibnameStmt(java.lang.String lasrFormatLibnameStmt) String representing the XML libname statment to use when exporting user-defined-formats
abstract Export	lasrFormatLibref(java.lang.String lasrFormatLib) Lasr format library to use, if not set 'lsrfmts' will be assumed.
abstract Export	lasrHost(java.lang.String host) Lasr host
abstract Export	lasrInstall(java.lang.String install) Lasr Install option
abstract Export	lasrNodes(int nodes) Number of Lasr nodes
abstract Export	lasrNthreads(int nthreads) Number of Lasr threads
abstract Export	lasrPath(java.lang.String path) Lasr path name
abstract Export	lasrPort(int port) Lasr port number
abstract Export	lasrSigner(java.lang.String signer) Lasr signer
abstract Export	libref(java.lang.String libref) SAS libref specified when exporting to SAS library
abstract Export	metaLibref(java.lang.String metaLibref) proc metalib libref to register the table
abstract Export	metaPort(java.lang.String metaPort) proc metalib port number
abstract Export	metaPswd(java.lang.String metaPswd) proc metalib password
abstract Export	metaRepname(java.lang.String metaRepname) proc metalib repository name
abstract Export	metaServer(java.lang.String metaServer) proc metalib server
abstract Export	metaUser(java.lang.String metaUser) proc metalib username
abstract Export	onlyReferencedUDFs(boolean onlyReferencedUdfs) A boolean indicating whether only referenced user-defined-formats in the business model are exported.
abstract Export	options(java.lang.String options) Engine options specified when exporting to SAS library
abstract Export	outfile(java.lang.String outfile) Filename for proc export target when generating CSV files
abstract Export	path(java.lang.String path) Libname path when exporting to SAS library
abstract void	run()
abstract ResultSetInterface	run(QueryConnector queryConnector) This method executes the Export statement and returns a ResultSetInterface.
abstract Export	SASLibrary(com.sas.iquery.metadata.physical.SASLibrary library) SAS Library object specified when exporting to SAS library
abstract Export	server(com.sas.iquery.metadata.physical.SASWorkspaceServer server)
abstract void	setColumnLimit(int columnLimit)
abstract void	setResultSetTableName(java.lang.String resultSetTableName)
abstract void	setTableLimit(int tableLimit)
abstract Export	tableName(java.lang.String tableName) Tablename to create when exporting to SAS library
abstract Export	udfOutputTableLibref(java.lang.String udfTableLibref) Name of a temporary output library to use on the source server, when exporting user-defined-formats.
abstract Export	udfOutputTableName(java.lang.String udfTableName) Name of a temporary output table to use, when exporting user-defined-formats.

Method Detail

SASLibrary

Export SASLibrary(com.sas.iquery.metadata.physical.SASLibrary library)

SAS Library object specified when exporting to SAS library

libref

Export libref(java.lang.String libref)

SAS libref specified when exporting to SAS library

path

Export path(java.lang.String path)

Libname path when exporting to SAS library

engine

Export engine(java.lang.String engine)

Engine name specified when exporting to SAS library

options

Export options(java.lang.String options)

Engine options specified when exporting to SAS library

tableName

Export tableName(java.lang.String tableName)

Tablename to create when exporting to SAS library

outfile

Export outfile(java.lang.String outfile)

Filename for proc export target when generating CSV files

JSONout

Export JSONout(java.lang.String JSONout)

Filename for JSON when exporting to JSON file

JSONExportOptions

Export JSONExportOptions(java.lang.String JSONExportOptions,
                         java.lang.String JSONExportTablename)

JSON Export options

JSONOptions

Export JSONOptions(java.lang.String JSONOptions)

JSON options

lasrData

Export lasrData(java.lang.String data)
                throws GenerationException,
                       DataRetrievalException

Used when exporting a single Table based on a String

Throws:

GenerationException

DataRetrievalException

lasrData

Export lasrData(com.sas.iquery.metadata.physical.Table table)
                throws GenerationException,
                       DataRetrievalException

Used when exporting a single table from a Table object

Throws:

GenerationException

DataRetrievalException

lasrCreate

Export lasrCreate(java.lang.String createFile)

File used on Create for proc lasr

lasrCreate

Export lasrCreate()

proc lasr Create option without a table

lasrAdd

Export lasrAdd()

For adding a table to LASR using an existing server

lasrPath

Export lasrPath(java.lang.String path)

Lasr path name

lasrHost

Export lasrHost(java.lang.String host)

Lasr host

lasrPort

Export lasrPort(int port)

Lasr port number

lasrSigner

Export lasrSigner(java.lang.String signer)

Lasr signer

lasrInstall

Export lasrInstall(java.lang.String install)

Lasr Install option

lasrNodes

Export lasrNodes(int nodes)

Number of Lasr nodes

lasrNthreads

Export lasrNthreads(int nthreads)

Number of Lasr threads

metaUser

Export metaUser(java.lang.String metaUser)

proc metalib username

metaPswd

Export metaPswd(java.lang.String metaPswd)

proc metalib password

metaServer

Export metaServer(java.lang.String metaServer)

proc metalib server

metaRepname

Export metaRepname(java.lang.String metaRepname)

proc metalib repository name

metaPort

Export metaPort(java.lang.String metaPort)

proc metalib port number

metaLibref

Export metaLibref(java.lang.String metaLibref)

proc metalib libref to register the table

server

Export server(com.sas.iquery.metadata.physical.SASWorkspaceServer server)

getExportProperties

com.sas.iquery.metadata.business.ExportProperties[] getExportProperties()

Returns:

Returns the exportProperties.

isAllDetail

boolean isAllDetail()

isDetailWithFilters

boolean isDetailWithFilters()

isViewOnly

boolean isViewOnly()

isTableOnly

boolean isTableOnly()

isCreateTableRequiredForExport

boolean isCreateTableRequiredForExport()

isMetalibInEffect

boolean isMetalibInEffect()

getResultSetTableName

java.lang.String getResultSetTableName()

Returns:

Returns the resultSetTableName.

setResultSetTableName

void setResultSetTableName(java.lang.String resultSetTableName)

Parameters:

resultSetTableName - The resultSetTableName to set.

createTableDataSelection

com.sas.iquery.metadata.business.CreateTableDataSelection createTableDataSelection(DataSelection selection,
                                                                                   com.sas.iquery.strategies.sas.oma.AbstractStrategy strategy)
                                                                                   throws MetadataException

Throws:

MetadataException

generateExportStatementForCSV

java.lang.StringBuffer generateExportStatementForCSV(java.lang.String inputTable)
                                                     throws DataRetrievalException

Throws:

DataRetrievalException

generateJSONStatement

java.lang.StringBuffer generateJSONStatement(java.lang.String inputTable)
                                             throws DataRetrievalException

Throws:

DataRetrievalException

generateLasrStatement

java.lang.StringBuffer generateLasrStatement()
                                             throws DataRetrievalException

Throws:

DataRetrievalException

generateLasrStatement

java.lang.StringBuffer generateLasrStatement(java.lang.String inputTable)
                                             throws DataRetrievalException

Throws:

DataRetrievalException

isTooManyTablesOrColumns

boolean isTooManyTablesOrColumns()
                                 throws MetadataException

Throws:

MetadataException

getColumnLimit

int getColumnLimit()

setColumnLimit

void setColumnLimit(int columnLimit)

getTableLimit

int getTableLimit()

setTableLimit

void setTableLimit(int tableLimit)

generateProcMetalib

java.lang.StringBuffer generateProcMetalib(java.lang.String inputTable)
                                           throws DataRetrievalException

Parameters:

tableName -

Returns:

Throws:

DataRetrievalException

generate

java.lang.String generate(java.lang.String tableName)
                          throws ExecutionException,
                                 com.sas.iquery.intelligentquery.IntelligentQueryException,
                                 MetadataException

This method generates the ResultSet/Export code based on a caller-defined tableName and returns a String containing the generated code. The code is simply generated. If you want to execute the code, you need to call export.run(). If the caller specified the RESULT_SET_ONLY property, then just the ResultSet code will get generated.

Throws:

ExecutionException

com.sas.iquery.intelligentquery.IntelligentQueryException

MetadataException

generate

java.lang.String generate()
                          throws ExecutionException,
                                 com.sas.iquery.intelligentquery.IntelligentQueryException,
                                 MetadataException

This method generates the ResultSet/Export code and returns a String containing the generated code. The code is simply generated. If you want to execute the code, you need to call export.run(). If the caller specified the RESULT_SET_ONLY property, then just the ResultSet code will get generated.

Throws:

ExecutionException

com.sas.iquery.intelligentquery.IntelligentQueryException

MetadataException

run

void run()
         throws DataRetrievalException,
                ExecutionException,
                MetadataException

Throws:

DataRetrievalException

ExecutionException

MetadataException

run

ResultSetInterface run(QueryConnector queryConnector)
                       throws DataRetrievalException,
                              MetadataException

This method executes the Export statement and returns a ResultSetInterface. Since Export is a one-way operation, only an empty result set is returned. However, other info (like the SASLog) is available off of the ResultSet.

Parameters:

queryConnector -

Returns:

Throws:

DataRetrievalException

MetadataException

getlasrDataSourceTable

com.sas.iquery.metadata.business.DataSourceTable getlasrDataSourceTable()

Returns:

Returns the Table for stand-alone submission.

getUsage

com.sas.iquery.metadata.business.ExportType getUsage()

Returns:

Returns the usage.

getSASLibrary

com.sas.iquery.metadata.physical.SASLibrary getSASLibrary()

Returns:

Returns the SASLibrary.

getExportMetadata

ExportSelectionMetadata getExportMetadata()
                                          throws MetadataException

The metadata to be exported (ie the metadata about what is to be exported). This method returns the metadata object which is a high-level "container" for all metadata associated with this export's underlying data selection. Such metadata includes column info, filters, data sources, hierarchies, levels, etc...

Throws:

MetadataException

getUploadMetadata

ExportUploadMetadata getUploadMetadata()
                                       throws MetadataException

The metadata to be uploaded (ie the metadata about the query to upload). This method returns the metadata object which is a high-level "container" for all the metadata associated with this export's actual upload data selection.

Returns:

Throws:

MetadataException

lasrFormatLibref

Export lasrFormatLibref(java.lang.String lasrFormatLib)

Lasr format library to use, if not set 'lsrfmts' will be assumed.

getLasrFormatLibref

java.lang.String getLasrFormatLibref()

Returns:

Returns the format library to use in the Lasr or target server. 'lsrfmts' is the default.

udfOutputTableName

Export udfOutputTableName(java.lang.String udfTableName)

Name of a temporary output table to use, when exporting user-defined-formats. The table holds a list of user-defined formats and their associated catalogs. 'iqfmts' is the default.

getUdfOutputTableName

java.lang.String getUdfOutputTableName()

Returns:

Returns the name of a temporary output table to use on the source server, when exporting user-defined-formats. 'iqfmts' is the default.

udfOutputTableLibref

Export udfOutputTableLibref(java.lang.String udfTableLibref)

Name of a temporary output library to use on the source server, when exporting user-defined-formats.

getUdfOutputTableLibref

java.lang.String getUdfOutputTableLibref()

Returns:

Returns the name of a temporary output library to use on the source server, when exporting user-defined-formats.

lasrFormatLibnameStmt

Export lasrFormatLibnameStmt(java.lang.String lasrFormatLibnameStmt)

String representing the XML libname statment to use when exporting user-defined-formats. " XML92 xmltype=sasfmt tagset=tagsets.XMLsuv;" is the default.

getLasrFormatLibnameStmt

java.lang.String getLasrFormatLibnameStmt()

Returns:

Returns a String representing the XML libname statement that will be used to export user-defined formats. " XML92 xmltype=sasfmt tagset=tagsets.XMLsuv;" is the default.

getOnlyReferencedUDFs

boolean getOnlyReferencedUDFs()

Returns:

Returns a boolean indicating whether only referenced user-defined-formats in the business model are exported. The default is true.

onlyReferencedUDFs

Export onlyReferencedUDFs(boolean onlyReferencedUdfs)

A boolean indicating whether only referenced user-defined-formats in the business model are exported. The default is true.

generateUdfStatement

java.lang.String generateUdfStatement()
                                      throws DataRetrievalException

Returns:

Returns generated SAS code for exporting user-defined-formats from one system to another.

Throws:

DataRetrievalException

getIncludeAllColumns

boolean getIncludeAllColumns()

Returns:

Returns a boolean indicating whether all columns should be included from the based tables returned instead of only the referenced columns. The default is false to return only referenced columns.

includeAllColumns

Export includeAllColumns(boolean includeAllColumns)

A boolean indicating whether only the all columns should be included from the based tables.

getIgnoreReachThruTable

boolean getIgnoreReachThruTable()

Returns:

Returns a boolean indicating whether a reachthru table will be returned instead of a star schema. The default is false to not ignore the reach thru table and return it if it is valid.

ignoreReachThruTable

Export ignoreReachThruTable(boolean ignoreReachThruTable)

A boolean indicating whether the reach thru table should be ignored and all of the joined star schema tables should be returned.