org.basex.core
Class Databases

java.lang.Object
  extended by org.basex.core.Databases

public final class Databases
extends java.lang.Object

Manages a two-way-map of all available databases and backups. Used for locking.

Author:
BaseX Team 2005-12, BSD License, Jens Erat

Field Summary
static java.lang.String DBCHARS
          Allowed characters for database names (additional to letters and digits).
static java.lang.String REGEXCHARS
          Regex representation of allowed database characters.
 
Method Summary
static StringList backupPaths(java.lang.String db, Context ctx)
          Returns the paths of all backups of the specified database.
 StringList backups(java.lang.String prefix)
          Lists all available backups matching the specified prefix.
 StringList list()
          Lists all available databases and backups.
 StringList listDBs()
          Lists all available databases.
 StringList listDBs(java.lang.String name)
          Lists all available databases matching the given name.
static boolean validChar(int ch)
          Checks if the specified character is a valid character for a database name.
static boolean validName(java.lang.String name)
          Checks if the specified string is a valid database name.
static boolean validName(java.lang.String name, boolean glob)
          Checks if the specified string is a valid database name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DBCHARS

public static final java.lang.String DBCHARS
Allowed characters for database names (additional to letters and digits). The following characters are invalid:

See Also:
Constant Field Values

REGEXCHARS

public static final java.lang.String REGEXCHARS
Regex representation of allowed database characters.

Method Detail

list

public StringList list()
Lists all available databases and backups.

Returns:
database and backup list

listDBs

public StringList listDBs()
Lists all available databases.

Returns:
database list

listDBs

public StringList listDBs(java.lang.String name)
Lists all available databases matching the given name. Supports glob patterns.

Parameters:
name - database name, glob patterns allowed
Returns:
database list

backups

public StringList backups(java.lang.String prefix)
Lists all available backups matching the specified prefix.

Parameters:
prefix - prefix (may be null)
Returns:
database list

backupPaths

public static StringList backupPaths(java.lang.String db,
                                     Context ctx)
Returns the paths of all backups of the specified database.

Parameters:
db - database
ctx - database context
Returns:
paths of available backups

validChar

public static boolean validChar(int ch)
Checks if the specified character is a valid character for a database name.

Parameters:
ch - the character to be checked
Returns:
result of check

validName

public static boolean validName(java.lang.String name)
Checks if the specified string is a valid database name.

Parameters:
name - name to be checked
Returns:
result of check

validName

public static boolean validName(java.lang.String name,
                                boolean glob)
Checks if the specified string is a valid database name.

Parameters:
name - name to be checked
glob - allow glob syntax
Returns:
result of check