weka.core.metastore

Class XMLFileBasedMetaStore

java.lang.Object

weka.core.metastore.XMLFileBasedMetaStore

All Implemented Interfaces:

MetaStore

public class XMLFileBasedMetaStore
extends java.lang.Object
implements MetaStore

A simple default implementation of MetaStore that uses Weka's XML serialization mechanism to persist entries as XML files in ${WEKA_HOME}/wekaMetaStore

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_STORE_LOCATION The default location for the XML files
protected boolean	m_storeDirOK True if the store home has been successfully established
protected java.io.File	m_storeHome The current home of the store
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.File>>	m_stores Lookup for entries in the stores - just holds entry names and File paths

Constructor Summary

Constructors

Constructor and Description
XMLFileBasedMetaStore()

Method Summary

Modifier and Type	Method and Description
void	createStore(java.lang.String storeName) Create a named store
protected void	establishStoreHome() Establish the home directory for the store
java.lang.Object	getEntry(java.lang.String storeName, java.lang.String name, java.lang.Class<?> clazz) Get a named entry from the store
protected XMLBasicSerialization	getSerializer() Gets a serializer to use.
java.util.Set<java.lang.String>	listMetaStoreEntries(java.lang.String storeName) Get a list of all entries in a named store
java.util.Set<java.lang.String>	listMetaStoreEntries(java.lang.String storeName, java.lang.String prefix) Get a list of all named entries starting with the given prefix
java.util.Set<java.lang.String>	listMetaStores() Get a list of all named meta stores
protected void	lockStore() Lock the store
void	storeEntry(java.lang.String storeName, java.lang.String name, java.lang.Object toStore) Store a named entry
protected void	unlockStore() Unlocks the metastore

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_STORE_LOCATION

public static final java.lang.String DEFAULT_STORE_LOCATION

The default location for the XML files

m_storeHome

protected java.io.File m_storeHome

The current home of the store

m_storeDirOK

protected boolean m_storeDirOK

True if the store home has been successfully established

m_stores

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.File>> m_stores

Lookup for entries in the stores - just holds entry names and File paths

Constructor Detail

XMLFileBasedMetaStore

public XMLFileBasedMetaStore()

Method Detail

establishStoreHome

protected void establishStoreHome()
                           throws java.io.IOException

Establish the home directory for the store

Throws:

java.io.IOException - if a problem occurs

listMetaStores

public java.util.Set<java.lang.String> listMetaStores()
                                               throws java.io.IOException

Description copied from interface: MetaStore

Get a list of all named meta stores

Specified by:

listMetaStores in interface MetaStore

Returns:

a list of meta stores

Throws:

java.io.IOException - if a problem occurs

listMetaStoreEntries

public java.util.Set<java.lang.String> listMetaStoreEntries(java.lang.String storeName)
                                                     throws java.io.IOException

Description copied from interface: MetaStore

Get a list of all entries in a named store

Specified by:

listMetaStoreEntries in interface MetaStore

Parameters:

storeName - the name of the store to get entries for

Returns:

a list of all entries in the named store

Throws:

java.io.IOException - if a problem occurs

listMetaStoreEntries

public java.util.Set<java.lang.String> listMetaStoreEntries(java.lang.String storeName,
                                                            java.lang.String prefix)
                                                     throws java.io.IOException

Description copied from interface: MetaStore

Get a list of all named entries starting with the given prefix

Specified by:

listMetaStoreEntries in interface MetaStore

Parameters:

storeName - the name of the store to get entries for

prefix - the prefix with which to search for entries

Returns:

a list of entries

Throws:

java.io.IOException - if a problem occurs

getEntry

public java.lang.Object getEntry(java.lang.String storeName,
                                 java.lang.String name,
                                 java.lang.Class<?> clazz)
                          throws java.io.IOException

Description copied from interface: MetaStore

Get a named entry from the store

Specified by:

getEntry in interface MetaStore

Parameters:

storeName - the name of the store to use

name - the full name of the entry to retrieve

clazz - the expected class of the entry when deserialized

Returns:

the deserialized entry or null if the name does not exist in the store

Throws:

java.io.IOException - if the deserialized entry does not match the expected class

createStore

public void createStore(java.lang.String storeName)
                 throws java.io.IOException

Description copied from interface: MetaStore

Create a named store

Specified by:

createStore in interface MetaStore

Parameters:

storeName - the name of the store to create

Throws:

java.io.IOException - if a problem occurs

storeEntry

public void storeEntry(java.lang.String storeName,
                       java.lang.String name,
                       java.lang.Object toStore)
                throws java.io.IOException

Description copied from interface: MetaStore

Store a named entry

Specified by:

storeEntry in interface MetaStore

Parameters:

storeName - the name of the store to use

name - the full name of the entry to store

toStore - a beans compliant object to store

Throws:

java.io.IOException - if a problem occurs

lockStore

protected void lockStore()
                  throws java.io.IOException

Lock the store

Throws:

java.io.IOException - if a problem occurs

unlockStore

protected void unlockStore()

Unlocks the metastore

getSerializer

protected XMLBasicSerialization getSerializer()

Gets a serializer to use. Creates a subclass of XMLBasicSerialization that has allowed properties set for common option handlers.

Returns:

a serializer instance