org.b3log.latke.repository

Interface Repository

All Known Implementing Classes:

AbstractRepository, JdbcRepository, NoneRepository

public interface Repository

Repository.

Version:

1.5.0.2, Jun 6, 2019

Author:

Liang Ding

Method Summary

Modifier and Type	Method and Description
String	add(JSONObject jsonObject) Adds the specified json object.
Transaction	beginTransaction() Begins a transaction against the repository.
long	count() Gets the count of all json objects.
long	count(Query query) Gets the count of json objects by the specified query.
Map<String,JSONObject>	get(Iterable<String> ids) Gets json objects by the specified ids.
JSONObject	get(Query query) Gets json objects by the specified query.
JSONObject	get(String id) Gets a json object by the specified id.
default JSONObject	getFirst(Query query) Gets the first result json object by the specified query.
default List<JSONObject>	getList(Query query) Get json objects by the specified query.
String	getName() Gets the name of this repository.
List<JSONObject>	getRandomly(int fetchSize) Gets a list of json objects randomly with the specified fetch size.
boolean	has(String id) Determines a json object specified by the given id exists in this repository.
boolean	hasTransactionBegun() Whether the repository within a transaction.
boolean	isWritable() Whether the repository is writable.
void	remove(Query query) Removes json objects by the specified query.
void	remove(String id) Removes a json object by the specified id.
List<JSONObject>	select(String statement, Object... params) Gets json objects by the specified query statement.
void	setDebug(boolean debugEnabled) Sets whether the repository is debug to show SQL with the specified flag.
void	setWritable(boolean writable) Sets whether the repository is writable with the specified flag.
void	update(String id, JSONObject jsonObject, String... propertyNames) Updates a certain json object specified by the given id with the specified new json object and property names.

Method Detail

add

String add(JSONObject jsonObject)
    throws RepositoryException

Adds the specified json object.

Parameters:

jsonObject - the specified json object

Returns:

the generated object id

Throws:

RepositoryException - repository exception

update

void update(String id,
            JSONObject jsonObject,
            String... propertyNames)
     throws RepositoryException

Updates a certain json object specified by the given id with the specified new json object and property names.

Parameters:

id - the specified id

jsonObject - the specified new json object

propertyNames - the specified property names to update, update all properties if not specified

Throws:

RepositoryException - repository exception

remove

void remove(String id)
     throws RepositoryException

Removes a json object by the specified id.

Parameters:

id - the specified id

Throws:

RepositoryException - repository exception

remove

void remove(Query query)
     throws RepositoryException

Removes json objects by the specified query.

Parameters:

query - the specified query

Throws:

RepositoryException - repository exception

get

JSONObject get(String id)
        throws RepositoryException

Gets a json object by the specified id.

Parameters:

id - the specified id

Returns:

a json object, returns null if not found

Throws:

RepositoryException - repository exception

get

Map<String,JSONObject> get(Iterable<String> ids)
                    throws RepositoryException

Gets json objects by the specified ids.

Parameters:

ids - the specified ids

Returns:

json objects matched in the specified ids

Throws:

RepositoryException - repository exception

has

boolean has(String id)
     throws RepositoryException

Determines a json object specified by the given id exists in this repository.

Parameters:

id - the given id

Returns:

true if it exists, otherwise false

Throws:

RepositoryException - repository exception

get

JSONObject get(Query query)
        throws RepositoryException

Gets json objects by the specified query.

Pagination

If the "paginationPageCount" has been specified (not with -1 or null) by caller (as the argument Query.setPageCount(int)), the value will be used in the returned value. In other words, the page count result will not be calculated by this interface, otherwise, the returned value pagination.paginationPageCount and pagination.paginationRecordCount will be calculated with query condition.

Note: The order of elements of the returned result list is decided by datastore implementation, excepts Query.addSort(java.lang.String, org.b3log.latke.repository.SortDirection) be invoked.

Parameters:

query - the specified query

Returns:

for example,

 {
     "pagination": {
       "paginationPageCount": 10, // May be specified by the specified query.pageCount
       "paginationRecordCount": "100" // If query.pageCount has been specified with not  -1 or  null, this value will
                                         be  0 also
     },
     "rslts": [{
         "oId": "...."
     }, ....]
 }
 

Throws:

RepositoryException - repository exception

getList

default List<JSONObject> getList(Query query)
                          throws RepositoryException

Get json objects by the specified query. Calling this interface just returns result object list, no pagination info.

Parameters:

query - the specified query

Returns:

a list of result json object, returns an empty list if not found

Throws:

RepositoryException - repository exception

getFirst

default JSONObject getFirst(Query query)
                     throws RepositoryException

Gets the first result json object by the specified query.

Parameters:

query - the specified query

Returns:

the first record in the query result list, returns null if not found

Throws:

RepositoryException - repository exception

select

List<JSONObject> select(String statement,
                        Object... params)
                 throws RepositoryException

Gets json objects by the specified query statement.

Parameters:

statement - the specified query statement

params - the specified parameters

Returns:

a list of result, returns an empty list if not found

Throws:

RepositoryException - repository exception

getRandomly

List<JSONObject> getRandomly(int fetchSize)
                      throws RepositoryException

Gets a list of json objects randomly with the specified fetch size.

Parameters:

fetchSize - the specified fetch size

Returns:

a list of json objects, its size less or equal to the specified fetch size, returns an empty list if not found

Throws:

RepositoryException - repository exception

count

long count()
    throws RepositoryException

Gets the count of all json objects.

Returns:

count, returns -1 if not available

Throws:

RepositoryException - repository exception

count

long count(Query query)
    throws RepositoryException

Gets the count of json objects by the specified query.

Parameters:

query - the specified query

Returns:

count, returns -1 if not available

Throws:

RepositoryException - repository exception

getName

String getName()

Gets the name of this repository.

Returns:

the name of this repository

beginTransaction

Transaction beginTransaction()

Begins a transaction against the repository.

Callers are responsible for explicitly calling Transaction.commit() or Transaction.rollback() when they no longer need the Transaction. The Transaction returned by this call will be considered the current transaction until one of the following happens:

1. beginTransaction() is invoked from the same thread
2. Transaction.commit() is invoked on the Transaction returned by this method
Whether or not the commit returns successfully, the Transaction will no longer be the current transaction.
3. Transaction.rollback() is invoked on the Transaction returned by this method
Whether or not the rollback returns successfully, the Transaction will no longer be the current transaction.

Returns:

the transaction that was started.

hasTransactionBegun

boolean hasTransactionBegun()

Whether the repository within a transaction.

Returns:

true if the repository within a transaction, returns false otherwise

isWritable

boolean isWritable()

Whether the repository is writable.

Returns:

true if it is writable, returns false otherwise

setWritable

void setWritable(boolean writable)

Sets whether the repository is writable with the specified flag.

Parameters:

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

setDebug

void setDebug(boolean debugEnabled)

Sets whether the repository is debug to show SQL with the specified flag.

Parameters:

debugEnabled - the specified flag, true for enabled, false otherwise