at.spardat.xma.datasource
Interface ITabularDataSource

All Known Implementing Classes:
TabularDataSourceClient, XMATabularDataSourceServer

public interface ITabularDataSource

Classes implementing this interface are able to provide tabular data. ITabularData is the interface specification for the XMA tabular data plugin. A XMA application provides a server and a client side implementation. There are default implementations available.

Usage of this interface: The implementor is able to provide a ITabularData for a provided table specification. The specification is a String that must abide to the following syntax (example):

 type=sddom,name=BETRART
 
I.e., a comma separated list of attributes as key/value pairs. The attribute type is reserved and should be used to discrimitate different data sources. Depending on the type, more attributes might be required. The following types are reserved:
 type            meaning
 -------------------------------------------------------------------------------------------
 rsc             the table is loaded from a resource bundle, see RessourceBundleProviderServer.
                 The syntax is type=rsc,bundle=at.spardat. ... .BundleName
 sddom           see at.spardat.enterprise.atom.ADomain
 ress            see at.spardat.enterprise.atom.ADomain
 res             see at.spardat.enterprise.atom.ADomain
 


Field Summary
static long UNKNOWN_TIMESTAMP
          Constant for a timestamp that is unknown.
 
Method Summary
 ITabularDomData getDomTable(java.lang.String spec, XMASession session)
          Convenience method to retrieve a table that contains domain values.
 ITabularData getTable(java.lang.String spec, XMASession session)
          Retrieves a table from this data source.
 

Field Detail

UNKNOWN_TIMESTAMP

public static final long UNKNOWN_TIMESTAMP
Constant for a timestamp that is unknown. May be used to specify unknown last modified timestamps.

See Also:
Constant Field Values
Method Detail

getTable

public ITabularData getTable(java.lang.String spec,
                             XMASession session)
Retrieves a table from this data source.

Parameters:
spec - identifies a table as defined above.
session - XMASession
Returns:
the table data. The returned table is never null.
Throws:
java.lang.RuntimeException - note that this method may throw a set of RuntimeExceptions.

getDomTable

public ITabularDomData getDomTable(java.lang.String spec,
                                   XMASession session)
Convenience method to retrieve a table that contains domain values. Not that this method may only be called if the underlying tabular data is indeed a domain table. It is the ITableProvider-implementor that decides on this.

Parameters:
spec - identifies a table as defined above.
session - XMASession
Returns:
the table data. The returned table is never null.
Throws:
java.lang.RuntimeException - note that this method may throw a set of RuntimeExceptions.