org.apache.activemq.kaha
Interface Store

All Known Implementing Classes:

KahaStore

public interface Store

A Store is holds persistent containers

Version:

$Revision: 1.2 $

Field Summary

static Marshaller	BytesMarshaller Byte Marshaller
static Marshaller	ObjectMarshaller Object Marshaller
static Marshaller	StringMarshaller String Marshaller

Method Summary

void	clear() empty all the contents of the store
void	close() close the store
boolean	delete() delete the store
void	deleteListContainer(java.lang.Object id) delete a ListContainer from the default container
void	deleteListContainer(java.lang.Object id, java.lang.String containerName) delete a ListContainer from the named container
void	deleteMapContainer(java.lang.Object id) delete a container from the default container
void	deleteMapContainer(java.lang.Object id, java.lang.String containerName) delete a MapContainer from the name container
boolean	doesListContainerExist(java.lang.Object id) Checks if a ListContainer exists in the default container
boolean	doesListContainerExist(java.lang.Object id, java.lang.String containerName) Checks if a ListContainer exists in the named container
boolean	doesMapContainerExist(java.lang.Object id) Checks if a MapContainer exists in the default container
boolean	doesMapContainerExist(java.lang.Object id, java.lang.String containerName) Checks if a MapContainer exists in the named container
void	force() Force all writes to disk
java.lang.String	getIndexType()
ListContainer	getListContainer(java.lang.Object id) Get a ListContainer with the given id and creates it if it doesn't exist
ListContainer	getListContainer(java.lang.Object id, java.lang.String containerName) Get a ListContainer with the given id and creates it if it doesn't exist
ListContainer	getListContainer(java.lang.Object id, java.lang.String containerName, java.lang.String indexType) Get a ListContainer with the given id and creates it if it doesn't exist
java.util.Set	getListContainerIds() Get a Set of call ListContainer Ids
MapContainer	getMapContainer(java.lang.Object id) Get a MapContainer with the given id - the MapContainer is created if needed
MapContainer	getMapContainer(java.lang.Object id, java.lang.String containerName) Get a MapContainer with the given id - the MapContainer is created if needed
MapContainer	getMapContainer(java.lang.Object id, java.lang.String containerName, java.lang.String indexType) Get a MapContainer with the given id - the MapContainer is created if needed
java.util.Set	getMapContainerIds() Get a Set of call MapContainer Ids
long	getMaxDataFileLength()
void	setIndexType(java.lang.String type) Set the default index type
void	setMaxDataFileLength(long maxDataFileLength)

Field Detail

BytesMarshaller

static final Marshaller BytesMarshaller

Byte Marshaller

ObjectMarshaller

static final Marshaller ObjectMarshaller

Object Marshaller

StringMarshaller

static final Marshaller StringMarshaller

String Marshaller

Method Detail

close

void close()
           throws java.io.IOException

close the store

Throws:

java.io.IOException

force

void force()
           throws java.io.IOException

Force all writes to disk

Throws:

java.io.IOException

clear

void clear()
           throws java.io.IOException

empty all the contents of the store

Throws:

java.io.IOException

delete

boolean delete()
               throws java.io.IOException

delete the store

Returns:

true if the delete was successful

Throws:

java.io.IOException

doesMapContainerExist

boolean doesMapContainerExist(java.lang.Object id)
                              throws java.io.IOException

Checks if a MapContainer exists in the default container

Parameters:

id -

Returns:

new MapContainer

Throws:

java.io.IOException

doesMapContainerExist

boolean doesMapContainerExist(java.lang.Object id,
                              java.lang.String containerName)
                              throws java.io.IOException

Checks if a MapContainer exists in the named container

Parameters:

id -

containerName -

Returns:

new MapContainer

Throws:

java.io.IOException

getMapContainer

MapContainer getMapContainer(java.lang.Object id)
                             throws java.io.IOException

Get a MapContainer with the given id - the MapContainer is created if needed

Parameters:

id -

Returns:

container for the associated id or null if it doesn't exist

Throws:

java.io.IOException

getMapContainer

MapContainer getMapContainer(java.lang.Object id,
                             java.lang.String containerName)
                             throws java.io.IOException

Get a MapContainer with the given id - the MapContainer is created if needed

Parameters:

id -

containerName -

Returns:

container for the associated id or null if it doesn't exist

Throws:

java.io.IOException

getMapContainer

MapContainer getMapContainer(java.lang.Object id,
                             java.lang.String containerName,
                             java.lang.String indexType)
                             throws java.io.IOException

Get a MapContainer with the given id - the MapContainer is created if needed

Parameters:

id -

containerName -

indexType -

Returns:

container for the associated id or null if it doesn't exist

Throws:

java.io.IOException

deleteMapContainer

void deleteMapContainer(java.lang.Object id)
                        throws java.io.IOException

delete a container from the default container

Parameters:

id -

Throws:

java.io.IOException

deleteMapContainer

void deleteMapContainer(java.lang.Object id,
                        java.lang.String containerName)
                        throws java.io.IOException

delete a MapContainer from the name container

Parameters:

id -

containerName -

Throws:

java.io.IOException

getMapContainerIds

java.util.Set getMapContainerIds()
                                 throws java.io.IOException

Get a Set of call MapContainer Ids

Returns:

the set of ids

Throws:

java.io.IOException

doesListContainerExist

boolean doesListContainerExist(java.lang.Object id)
                               throws java.io.IOException

Checks if a ListContainer exists in the default container

Parameters:

id -

Returns:

new MapContainer

Throws:

java.io.IOException

doesListContainerExist

boolean doesListContainerExist(java.lang.Object id,
                               java.lang.String containerName)
                               throws java.io.IOException

Checks if a ListContainer exists in the named container

Parameters:

id -

containerName -

Returns:

new MapContainer

Throws:

java.io.IOException

getListContainer

ListContainer getListContainer(java.lang.Object id)
                               throws java.io.IOException

Get a ListContainer with the given id and creates it if it doesn't exist

Parameters:

id -

Returns:

container for the associated id or null if it doesn't exist

Throws:

java.io.IOException

getListContainer

ListContainer getListContainer(java.lang.Object id,
                               java.lang.String containerName)
                               throws java.io.IOException

Get a ListContainer with the given id and creates it if it doesn't exist

Parameters:

id -

containerName -

Returns:

container for the associated id or null if it doesn't exist

Throws:

java.io.IOException

getListContainer

ListContainer getListContainer(java.lang.Object id,
                               java.lang.String containerName,
                               java.lang.String indexType)
                               throws java.io.IOException

Get a ListContainer with the given id and creates it if it doesn't exist

Parameters:

id -

containerName -

indexType -

Returns:

container for the associated id or null if it doesn't exist

Throws:

java.io.IOException

deleteListContainer

void deleteListContainer(java.lang.Object id)
                         throws java.io.IOException

delete a ListContainer from the default container

Parameters:

id -

Throws:

java.io.IOException

deleteListContainer

void deleteListContainer(java.lang.Object id,
                         java.lang.String containerName)
                         throws java.io.IOException

delete a ListContainer from the named container

Parameters:

id -

containerName -

Throws:

java.io.IOException

getListContainerIds

java.util.Set getListContainerIds()
                                  throws java.io.IOException

Get a Set of call ListContainer Ids

Returns:

the set of ids

Throws:

java.io.IOException

getMaxDataFileLength

long getMaxDataFileLength()

Returns:

the maxDataFileLength

setMaxDataFileLength

void setMaxDataFileLength(long maxDataFileLength)

Parameters:

maxDataFileLength - the maxDataFileLength to set

getIndexType

java.lang.String getIndexType()

Returns:

the default index type

See Also:

IndexTypes

setIndexType

void setIndexType(java.lang.String type)

Set the default index type

Parameters:

type -

See Also:

IndexTypes