Module io.xpipe.core

Package io.xpipe.core.source

Class DataSource<DS extends DataStore>

java.lang.Object

io.xpipe.core.util.JacksonizedValue

io.xpipe.core.source.DataSource<DS>

Direct Known Subclasses:

CollectionDataSource, RawDataSource, StructureDataSource, TableDataSource, TextDataSource

public abstract class DataSource<DS extends DataStore>
extends JacksonizedValue

Represents a formal description on what exactly makes up the actual data source and how to access/locate it for a given data store.

This instance is only valid in combination with its associated data store instance.

Field Summary

Fields

Modifier and Type	Field	Description
protected DS	store

Constructor Summary

Constructors

Constructor	Description
DataSource()

Method Summary

Modifier and Type	Method	Description
final <DSD extends DataSource<?>> DSD	asNeeded()	Casts this instance to the required type without checking whether a cast is possible.
void	checkComplete()
<T extends DataSource<DS>> T	copy()
static DataSource<?>	createInternalDataSource(DataSourceType t, DataStore store)
Optional<String>	determineDefaultName()	Determines on optional default name for this data store that is used when determining a suitable default name for a data source.
List<WriteMode>	getAvailableWriteModes()
DataFlow	getFlow()
DS	getStore()
abstract DataSourceType	getType()
boolean	isComplete()
DataSourceReadConnection	openReadConnection()
DataSourceConnection	openWriteConnection(WriteMode mode)
void	validate()
DataSource<DS>	withStore(DS store)

Methods inherited from class io.xpipe.core.util.JacksonizedValue

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

store

protected DS extends DataStore store

Constructor Details

DataSource

public DataSource()

Method Details

createInternalDataSource

public static DataSource<?> createInternalDataSource(DataSourceType t,
 DataStore store)

isComplete

public boolean isComplete()

checkComplete

public void checkComplete()
                   throws Exception

Throws:

Exception

validate

public void validate()
              throws Exception

Throws:

Exception

getAvailableWriteModes

public List<WriteMode> getAvailableWriteModes()

getFlow

public DataFlow getFlow()

copy

public <T extends DataSource<DS>> T copy()

withStore

public DataSource<DS> withStore(DS store)

asNeeded

public final <DSD extends DataSource<?>> DSD asNeeded()

Casts this instance to the required type without checking whether a cast is possible.

determineDefaultName

public Optional<String> determineDefaultName()

Determines on optional default name for this data store that is used when determining a suitable default name for a data source.

openReadConnection

public DataSourceReadConnection openReadConnection()
                                            throws Exception

Throws:

Exception

openWriteConnection

public DataSourceConnection openWriteConnection(WriteMode mode)
                                         throws Exception

Throws:

Exception

getStore

public DS getStore()

getType

public abstract DataSourceType getType()