org.b3log.latke.repository

Class Repositories

java.lang.Object

org.b3log.latke.repository.Repositories

public final class Repositories
extends Object

Repository utilities.

Version:

1.1.0.1, Nov 4, 2018

Author:

Liang Ding

Method Summary

Modifier and Type	Method and Description
static void	addRepository(Repository repository) Adds the specified repository.
static void	check(String repositoryName, JSONObject jsonObject, String... ignoredKeys) Determines whether the specified json object can not be persisted (add or update) into an repository which specified by the given repository name.
static boolean	getReposirotiesWritable() Whether all repositories is writable.
static JSONObject	getRepositoriesDescription() Gets repositories description.
static Repository	getRepository(String repositoryName) Gets a repository with the specified repository name.
static JSONObject	getRepositoryDef(String repositoryName) Gets the repository definition of an repository specified by the given repository name.
static JSONArray	getRepositoryKeysDef(String repositoryName) Gets the keys definition of an repository specified by the given repository name.
static JSONArray	getRepositoryNames() Gets repository names.
static void	setRepositoriesWritable(boolean writable) Sets all repositories whether is writable with the specified flag.

Methods inherited from class java.lang.Object

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

Method Detail

getReposirotiesWritable

public static boolean getReposirotiesWritable()

Whether all repositories is writable.

Returns:

true if they are writable, returns false otherwise

setRepositoriesWritable

public static void setRepositoriesWritable(boolean writable)

Sets all repositories whether is writable with the specified flag.

Parameters:

writable - the specified flat, true for writable, false otherwise

getRepositoryNames

public static JSONArray getRepositoryNames()

Gets repository names.

Returns:

repository names, for example,

 [
     "repository1", "repository2", ....
 ]
 

getRepositoriesDescription

public static JSONObject getRepositoriesDescription()

Gets repositories description.

Returns:

repositories description, returns null if not found or parse the description failed

check

public static void check(String repositoryName,
                         JSONObject jsonObject,
                         String... ignoredKeys)
                  throws RepositoryException

Determines whether the specified json object can not be persisted (add or update) into an repository which specified by the given repository name.

A valid json object to persist must match keys definitions (including type and length if had) in the repository description (repository.json) with the json object names itself.

The specified keys to ignore will be bypassed, regardless of matching keys definitions.

Parameters:

repositoryName - the given repository name (maybe with table name prefix)

jsonObject - the specified json object

ignoredKeys - the specified keys to ignore

Throws:

RepositoryException - if the specified json object can not be persisted

See Also:

Repository.add(org.json.JSONObject), Repository#update(java.lang.String, org.json.JSONObject)

getRepositoryDef

public static JSONObject getRepositoryDef(String repositoryName)

Gets the repository definition of an repository specified by the given repository name.

Parameters:

repositoryName - the given repository name (maybe with table name prefix)

Returns:

repository definition, returns null if not found

getRepositoryKeysDef

public static JSONArray getRepositoryKeysDef(String repositoryName)

Gets the keys definition of an repository specified by the given repository name.

Parameters:

repositoryName - the given repository name (maybe with table name prefix)

Returns:

keys definition, returns null if not found

getRepository

public static Repository getRepository(String repositoryName)

Gets a repository with the specified repository name.

Parameters:

repositoryName - the specified repository name

Returns:

repository, returns null if not found

addRepository

public static void addRepository(Repository repository)

Adds the specified repository.

Parameters:

repository - the specified repository