oracle.ide.persistence

Interface NameSpaceFactory

public interface NameSpaceFactory

Factory for NameSpace instances.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canOpen(java.lang.String location) Determine whether a given location can be opened.
void	closeStorage(java.lang.String location) Close the namespace storage.
void	deleteNameSpace(java.lang.String location, java.lang.String name) Delete a namespace.
void	deleteNameSpace(java.lang.String location, java.lang.String name, java.util.Collection<java.lang.String> secondaryKeys) Delete a namespace and associated secondary key data.
NameSpace	getNameSpace(java.lang.String location, java.lang.String name, int type, SecondaryKeyProvider provider) Get a namespace.
java.util.Iterator<java.lang.String>	getNameSpaceIterator(java.lang.String location, java.lang.String prefix, boolean ignorecase) Get an iterator of available namespace names.
java.util.Iterator<java.lang.String>	getReverseNameSpaceIterator(java.lang.String location, java.lang.String prefix, boolean ignorecase) Get an iterator of available namespace names, in reverse order.
void	shutdown() Shut down this factory.

Method Detail

getNameSpace

NameSpace getNameSpace(java.lang.String location,
                     java.lang.String name,
                     int type,
                     SecondaryKeyProvider provider)

Get a namespace.

Parameters:

location - the location of the namespace

name - the name of the namespace

type - the type of namespace, either NameSpace.NSTYPE_NORMAL or NameSpace.NSTYPE_PACKED

provider - the secondary key provider

Returns:

the namespace instance

getNameSpaceIterator

java.util.Iterator<java.lang.String> getNameSpaceIterator(java.lang.String location,
                                                        java.lang.String prefix,
                                                        boolean ignorecase)

Get an iterator of available namespace names.

Parameters:

location - the location to iterate

prefix - the prefix to match

ignorecase - whether to ignore case

Returns:

the namespace iterator

getReverseNameSpaceIterator

java.util.Iterator<java.lang.String> getReverseNameSpaceIterator(java.lang.String location,
                                                               java.lang.String prefix,
                                                               boolean ignorecase)

Get an iterator of available namespace names, in reverse order.

Parameters:

location - the location to iterate

prefix - the prefix to match

ignorecase - whether to ignore case

Returns:

the namespace iterator

deleteNameSpace

void deleteNameSpace(java.lang.String location,
                   java.lang.String name)

Delete a namespace.

Parameters:

location - the location of the namespace

name - the name of the namespace to be deleted

deleteNameSpace

void deleteNameSpace(java.lang.String location,
                   java.lang.String name,
                   java.util.Collection<java.lang.String> secondaryKeys)

Delete a namespace and associated secondary key data.

Parameters:

location - the location of the namespace

name - the name of the namespace to be deleted

secondaryKeys - the secondary keys associated with the namespace

canOpen

boolean canOpen(java.lang.String location)

Determine whether a given location can be opened. For example, a return value of false could indicate that the user does not have the necessary permission to open that location, or the location does not support file system features required by the implementation (such as file locks over network drives).

Parameters:

location - the location of the storage to be opened

Returns:

true if the storage location can be opened.

closeStorage

void closeStorage(java.lang.String location)

Close the namespace storage.

Parameters:

location - the location of the storage to be closed

shutdown

void shutdown()

Shut down this factory. Performs any cleanup that might be necessary.