com.archibus.datasource

Class DataSourceFactory

java.lang.Object

com.archibus.datasource.DataSourceFactory

public class DataSourceFactory
extends java.lang.Object

Factory class for data source objects.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_SEPARATOR Key separator.
static java.lang.String	TYPE_GROUPING Constant for type="grouping".
static java.lang.String	TYPE_NONE Constant for type="none" (stock data source).

Constructor Summary

Constructors

Constructor and Description
DataSourceFactory()

Method Summary

Modifier and Type	Method and Description
static DataSource	addIfAbsent(java.lang.String viewName, java.lang.String dataSourceId, DataSource dataSource) Adds data source instance to the cache using viewName:dataSourceId as a key.
static DataSource	addOrReplace(java.lang.String viewName, java.lang.String dataSourceId, DataSource dataSource) Adds data source instance to the cache using viewName:dataSourceId as a key.
static DataSource	addOrReplace(java.lang.String viewName, java.lang.String dataSourceId, DataSource dataSource, boolean loadAndAttachDefinition) Adds data source instance to the cache using viewName:dataSourceId as a key.
static java.lang.String	cacheToString() Prints the cache state to string.
static void	clearCache() Clears the cache.
static DataSource	createDataSource() Creates new empty data source instance.
static DataSource	createDataSource(java.lang.String type) Creates new empty data source instance for specified type.
static DataSource	createDataSourceForFields(java.lang.String[] tableNames, java.lang.String[] fieldNames)
static DataSource	createDataSourceForFields(java.lang.String[] tableNames, java.lang.String[] fieldNames, boolean isDistinct)
static DataSource	createDataSourceForFields(java.lang.String mainTableName, java.lang.String[] fieldNames) Creates data source instance for specified table name and field names.
static DataSource	createDataSourceForFields(java.lang.String mainTableName, java.lang.String[] fieldNames, boolean isDistinct)
static DataSource	createDataSourceForTable(java.lang.String tableName) Creates a data source for all fields in a specified table.
static int	getSize() Returns the number of objects in the cache.
static com.archibus.model.view.datasource.AbstractDataSourceDef	loadDataSourceDef(java.lang.String viewName, java.lang.String dataSourceId) Loads a data source definition from a view file.
static DataSource	loadDataSourceFromCache(java.lang.Object context, java.lang.String viewName, int groupIndex, java.lang.String dataSourceId) Creates data source instance for specified view, group index, and optional data source ID.
static DataSource	loadDataSourceFromFile(java.lang.String viewName, java.lang.String dataSourceId) Creates data source instance for specified view name and data source ID.
static java.lang.Object	remove(java.lang.String viewName, java.lang.String dataSourceId) Removes object from the cache if it exists.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NONE

public static final java.lang.String TYPE_NONE

Constant for type="none" (stock data source).

See Also:

Constant Field Values

TYPE_GROUPING

public static final java.lang.String TYPE_GROUPING

Constant for type="grouping".

See Also:

Constant Field Values

KEY_SEPARATOR

public static final java.lang.String KEY_SEPARATOR

Key separator.

See Also:

Constant Field Values

Constructor Detail

DataSourceFactory

public DataSourceFactory()

Method Detail

createDataSource

public static DataSource createDataSource()

Creates new empty data source instance.

Returns:

DataSource

createDataSource

public static DataSource createDataSource(java.lang.String type)

Creates new empty data source instance for specified type.

Returns:

DataSource

createDataSourceForTable

public static DataSource createDataSourceForTable(java.lang.String tableName)

Creates a data source for all fields in a specified table.

Parameters:

tableName -

Returns:

createDataSourceForFields

public static DataSource createDataSourceForFields(java.lang.String mainTableName,
                                                   java.lang.String[] fieldNames)
                                            throws com.archibus.utility.ExceptionBase

Creates data source instance for specified table name and field names.

Parameters:

mainTableName -

fieldNames -

Returns:

Throws:

com.archibus.utility.ExceptionBase

createDataSourceForFields

public static DataSource createDataSourceForFields(java.lang.String mainTableName,
                                                   java.lang.String[] fieldNames,
                                                   boolean isDistinct)
                                            throws com.archibus.utility.ExceptionBase

Throws:

com.archibus.utility.ExceptionBase

createDataSourceForFields

public static DataSource createDataSourceForFields(java.lang.String[] tableNames,
                                                   java.lang.String[] fieldNames)
                                            throws com.archibus.utility.ExceptionBase

Throws:

com.archibus.utility.ExceptionBase

createDataSourceForFields

public static DataSource createDataSourceForFields(java.lang.String[] tableNames,
                                                   java.lang.String[] fieldNames,
                                                   boolean isDistinct)
                                            throws com.archibus.utility.ExceptionBase

Throws:

com.archibus.utility.ExceptionBase

loadDataSourceFromFile

public static DataSource loadDataSourceFromFile(java.lang.String viewName,
                                                java.lang.String dataSourceId)
                                         throws com.archibus.utility.ExceptionBase

Creates data source instance for specified view name and data source ID.

Finds cached data source definition and creates a copy of it, so that cached definitions are never accessed directly and thus cannot be changed from the calling code.

If the data source is not found in the cache, loads the view object containing the data source, then adds loaded data source to the cache.

Parameters:

viewName - View file name without extension, i.e. 'ab-ex-wr-grid'.

dataSourceId - Data source ID attribute as defined in the view, i.e. 'wr-ds'.

Returns:

DataSource

Throws:

com.archibus.utility.ExceptionBase

loadDataSourceFromCache

public static DataSource loadDataSourceFromCache(java.lang.Object context,
                                                 java.lang.String viewName,
                                                 int groupIndex,
                                                 java.lang.String dataSourceId)
                                          throws com.archibus.utility.ExceptionBase

Creates data source instance for specified view, group index, and optional data source ID.

This method is for backward compatibility with Web Central 17.1 and is not recommended to use in new code.

Parameters:

context - Web Central context object, such as UserSessionImpl.

viewName - View file name without extension, i.e. 'ab-ex-wr-grid'.

groupIndex - 0-based index of the afmTableGroup in the view.

dataSourceId - Data source ID attribute as defined in the view, i.e. 'wr-ds'.

Returns:

DataSource

Throws:

com.archibus.utility.ExceptionBase

addIfAbsent

public static DataSource addIfAbsent(java.lang.String viewName,
                                     java.lang.String dataSourceId,
                                     DataSource dataSource)

Adds data source instance to the cache using viewName:dataSourceId as a key. If the data source has already been cached, does NOT replace it.

Parameters:

viewName - View file name without extension, i.e. 'ab-ex-wr-grid'.

dataSourceId - Data source ID attribute as defined in the view, i.e. 'wr-ds'.

dataSource - DataSource instance to be cached.

Returns:

Data source instance in cache.

addOrReplace

public static DataSource addOrReplace(java.lang.String viewName,
                                      java.lang.String dataSourceId,
                                      DataSource dataSource)

Adds data source instance to the cache using viewName:dataSourceId as a key. If the data source has already been cached, replaces the instance in the cache with the new instance.

Parameters:

viewName - View file name without extension, i.e. 'ab-ex-wr-grid'.

dataSourceId - Data source ID attribute as defined in the view, i.e. 'wr-ds'.

dataSource - DataSource instance to be cached.

Returns:

Data source instance in cache.

addOrReplace

public static DataSource addOrReplace(java.lang.String viewName,
                                      java.lang.String dataSourceId,
                                      DataSource dataSource,
                                      boolean loadAndAttachDefinition)

Adds data source instance to the cache using viewName:dataSourceId as a key. If the data source has already been cached, replaces the instance in the cache with the new instance.

Parameters:

viewName - View file name without extension, i.e. 'ab-ex-wr-grid'.

dataSourceId - Data source ID attribute as defined in the view, i.e. 'wr-ds'.

dataSource - DataSource instance to be cached.

loadAndAttachDefinition - If true, loads the data source definition from file and attaches it to the data source.

Returns:

Data source instance in cache.

remove

public static java.lang.Object remove(java.lang.String viewName,
                                      java.lang.String dataSourceId)

Removes object from the cache if it exists.

Parameters:

objectKey -

Returns:

Removed object if it was in the cache.

loadDataSourceDef

public static com.archibus.model.view.datasource.AbstractDataSourceDef loadDataSourceDef(java.lang.String viewName,
                                                                                         java.lang.String dataSourceId)

Loads a data source definition from a view file.

Parameters:

viewName - View file name without extension, i.e. 'ab-ex-wr-grid'.

dataSourceId - Data source ID attribute as defined in the view, i.e. 'wr-ds'.

Returns:

Data source definition, or null.

clearCache

public static void clearCache()

Clears the cache.

getSize

public static int getSize()

Returns the number of objects in the cache.

Returns:

cacheToString

public static java.lang.String cacheToString()

Prints the cache state to string.

Returns: