Package org.apache.cayenne.access
Class DataNode
- java.lang.Object
-
- org.apache.cayenne.access.DataNode
-
- All Implemented Interfaces:
QueryEngine
public class DataNode extends Object implements QueryEngine
An abstraction of a single physical data storage. This is usually a database server, but can potentially be some other storage type like an LDAP server, etc.
-
-
Field Summary
Fields Modifier and Type Field Description protected DbAdapteradapterprotected Map<String,DataMap>dataMapsprotected DataSourcedataSourceprotected StringdataSourceFactoryprotected StringdataSourceLocationprotected EntityResolverentityResolverprotected Stringnameprotected SchemaUpdateStrategyschemaUpdateStrategy
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddDataMap(DataMap map)Adds a DataMap to be handled by this node.BatchTranslatorbatchTranslator(BatchQuery query, String trimFunction)DbAdaptergetAdapter()Returns DbAdapter object.BatchTranslatorFactorygetBatchTranslatorFactory()DataMapgetDataMap(String name)Returns datamap with specified name, null if none presentCollection<DataMap>getDataMaps()Returns an unmodifiable collection of DataMaps handled by this DataNode.DataSourcegetDataSource()Returns DataSource used by this DataNode to obtain connections.StringgetDataSourceFactory()Returns a name of DataSourceFactory class for this node.EntityResolvergetEntityResolver()Returns EntityResolver that handles DataMaps of this node.JdbcEventLoggergetJdbcEventLogger()StringgetName()Returns node name.RowReaderFactorygetRowReaderFactory()SchemaUpdateStrategygetSchemaUpdateStrategy()SelectTranslatorFactorygetSelectTranslatorFactory()SQLTemplateProcessorgetSqlTemplateProcessor()DataNodelookupDataNode(DataMap dataMap)Returns a DataNode that should handle queries for all DataMap components.voidperformQueries(Collection<? extends Query> queries, OperationObserver callback)Runs queries using Connection obtained from internal DataSource.voidremoveDataMap(String mapName)voidremoveDataMap(DataMap map)RowReader<?>rowReader(RowDescriptor descriptor, QueryMetadata queryMetadata)Creates aRowReaderusing internalRowReaderFactory.RowReader<?>rowReader(RowDescriptor descriptor, QueryMetadata queryMetadata, Map<ObjAttribute,ColumnDescriptor> attributeOverrides)Creates aRowReaderusing internalRowReaderFactory.SelectTranslatorselectTranslator(SelectQuery<?> query)voidsetAdapter(DbAdapter adapter)voidsetBatchTranslatorFactory(BatchTranslatorFactory batchTranslatorFactory)voidsetDataMaps(Collection<DataMap> dataMaps)voidsetDataSource(DataSource dataSource)voidsetDataSourceFactory(String dataSourceFactory)voidsetEntityResolver(EntityResolver entityResolver)Sets EntityResolver.voidsetJdbcEventLogger(JdbcEventLogger logger)voidsetName(String name)voidsetRowReaderFactory(RowReaderFactory rowReaderFactory)voidsetSchemaUpdateStrategy(SchemaUpdateStrategy schemaUpdateStrategy)voidsetSelectTranslatorFactory(SelectTranslatorFactory selectTranslatorFactory)voidsetSqlTemplateProcessor(SQLTemplateProcessor sqlTemplateProcessor)StringtoString()
-
-
-
Field Detail
-
name
protected String name
-
dataSource
protected DataSource dataSource
-
adapter
protected DbAdapter adapter
-
dataSourceLocation
protected String dataSourceLocation
-
dataSourceFactory
protected String dataSourceFactory
-
entityResolver
protected EntityResolver entityResolver
-
schemaUpdateStrategy
protected SchemaUpdateStrategy schemaUpdateStrategy
-
-
Constructor Detail
-
DataNode
public DataNode()
Creates a new unnamed DataNode.
-
DataNode
public DataNode(String name)
Creates a new DataNode, assigning it a name.
-
-
Method Detail
-
getSchemaUpdateStrategy
public SchemaUpdateStrategy getSchemaUpdateStrategy()
- Since:
- 3.0
-
setSchemaUpdateStrategy
public void setSchemaUpdateStrategy(SchemaUpdateStrategy schemaUpdateStrategy)
- Since:
- 3.0
-
getJdbcEventLogger
public JdbcEventLogger getJdbcEventLogger()
- Since:
- 3.1
-
setJdbcEventLogger
public void setJdbcEventLogger(JdbcEventLogger logger)
- Since:
- 3.1
-
getName
public String getName()
Returns node name. Name is used to uniquely identify DataNode within a DataDomain.
-
setName
public void setName(String name)
-
getDataSourceFactory
public String getDataSourceFactory()
Returns a name of DataSourceFactory class for this node.
-
setDataSourceFactory
public void setDataSourceFactory(String dataSourceFactory)
-
getDataMaps
public Collection<DataMap> getDataMaps()
Returns an unmodifiable collection of DataMaps handled by this DataNode.
-
getDataMap
public DataMap getDataMap(String name)
Returns datamap with specified name, null if none present
-
setDataMaps
public void setDataMaps(Collection<DataMap> dataMaps)
-
addDataMap
public void addDataMap(DataMap map)
Adds a DataMap to be handled by this node.
-
removeDataMap
public void removeDataMap(DataMap map)
-
removeDataMap
public void removeDataMap(String mapName)
-
getDataSource
public DataSource getDataSource()
Returns DataSource used by this DataNode to obtain connections.
-
setDataSource
public void setDataSource(DataSource dataSource)
-
getAdapter
public DbAdapter getAdapter()
Returns DbAdapter object. This is a plugin that handles RDBMS vendor-specific features.
-
setAdapter
public void setAdapter(DbAdapter adapter)
-
lookupDataNode
public DataNode lookupDataNode(DataMap dataMap)
Returns a DataNode that should handle queries for all DataMap components.- Since:
- 1.1
-
performQueries
public void performQueries(Collection<? extends Query> queries, OperationObserver callback)
Runs queries using Connection obtained from internal DataSource.- Specified by:
performQueriesin interfaceQueryEngine- Since:
- 1.1
-
getEntityResolver
public EntityResolver getEntityResolver()
Returns EntityResolver that handles DataMaps of this node.- Specified by:
getEntityResolverin interfaceQueryEngine
-
setEntityResolver
public void setEntityResolver(EntityResolver entityResolver)
Sets EntityResolver. DataNode relies on externally set EntityResolver, so if the node is created outside of DataDomain stack, a valid EntityResolver must be provided explicitly.- Since:
- 1.1
-
rowReader
public RowReader<?> rowReader(RowDescriptor descriptor, QueryMetadata queryMetadata)
Creates aRowReaderusing internalRowReaderFactory.- Since:
- 4.0
-
rowReader
public RowReader<?> rowReader(RowDescriptor descriptor, QueryMetadata queryMetadata, Map<ObjAttribute,ColumnDescriptor> attributeOverrides)
Creates aRowReaderusing internalRowReaderFactory.- Since:
- 4.0
-
batchTranslator
public BatchTranslator batchTranslator(BatchQuery query, String trimFunction)
- Since:
- 4.0
-
selectTranslator
public SelectTranslator selectTranslator(SelectQuery<?> query)
- Since:
- 4.0
-
getRowReaderFactory
public RowReaderFactory getRowReaderFactory()
- Since:
- 4.0
-
setRowReaderFactory
public void setRowReaderFactory(RowReaderFactory rowReaderFactory)
- Since:
- 4.0
-
getBatchTranslatorFactory
public BatchTranslatorFactory getBatchTranslatorFactory()
- Since:
- 4.0
-
setBatchTranslatorFactory
public void setBatchTranslatorFactory(BatchTranslatorFactory batchTranslatorFactory)
- Since:
- 4.0
-
getSqlTemplateProcessor
public SQLTemplateProcessor getSqlTemplateProcessor()
- Since:
- 4.0
-
setSqlTemplateProcessor
public void setSqlTemplateProcessor(SQLTemplateProcessor sqlTemplateProcessor)
- Since:
- 4.0
-
getSelectTranslatorFactory
public SelectTranslatorFactory getSelectTranslatorFactory()
- Since:
- 4.0
-
setSelectTranslatorFactory
public void setSelectTranslatorFactory(SelectTranslatorFactory selectTranslatorFactory)
- Since:
- 4.0
-
-