at.spardat.xma.datasource
Class TabularDataSourceClient

java.lang.Object
  extended byat.spardat.xma.datasource.TabularDataSourceClient
All Implemented Interfaces:
ITabularDataSource

public class TabularDataSourceClient
extends java.lang.Object
implements ITabularDataSource

This is the client side implementation of the ITabularDataSource plugin. This implementation is part of the XMA runtime. It uses the file cache to load the table from the server. In the server side web application, it requires a servlet named tabular, which must serve the table.


Field Summary
 
Fields inherited from interface at.spardat.xma.datasource.ITabularDataSource
UNKNOWN_TIMESTAMP
 
Constructor Summary
TabularDataSourceClient()
           
 
Method Summary
 void emptyInMemoryCache()
          Removes all cached tables from the in-memory-cache.
 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)
          Loads a table from the file cache.
 boolean invalidate(java.lang.String spec, XMASession session)
          Removes the resource specified by spec from memory and from file cache.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TabularDataSourceClient

public TabularDataSourceClient()
Method Detail

invalidate

public boolean invalidate(java.lang.String spec,
                          XMASession session)
Removes the resource specified by spec from memory and from file cache.

Parameters:
spec -
session -
Returns:
true if resource was successfully removed - otherwise false
Since:
version_number

getTable

public ITabularData getTable(java.lang.String spec,
                             XMASession session)
Loads a table from the file cache. This method requires a servlet named tabular in the server side installation of XMA.

Specified by:
getTable in interface ITabularDataSource
Parameters:
spec - identifies a table as defined above.
session - XMASession
Returns:
the table data. The returned table is never null.
See Also:
ITabularDataSource.getTable(java.lang.String, at.spardat.xma.session.XMASession)

getDomTable

public ITabularDomData getDomTable(java.lang.String spec,
                                   XMASession session)
Description copied from interface: ITabularDataSource
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.

Specified by:
getDomTable in interface ITabularDataSource
Parameters:
spec - identifies a table as defined above.
session - XMASession
Returns:
the table data. The returned table is never null.
See Also:
ITabularDataSource.getDomTable(java.lang.String, at.spardat.xma.session.XMASession)

emptyInMemoryCache

public void emptyInMemoryCache()
Removes all cached tables from the in-memory-cache.