org.b3log.latke.repository

Class AbstractRepository

java.lang.Object

org.b3log.latke.repository.AbstractRepository

All Implemented Interfaces:

Repository

public abstract class AbstractRepository
extends Object
implements Repository

Abstract repository.

This is a base adapter for wrapped repository, the underlying repository will be instantiated in the constructor..

Version:

2.3.0.3, Jun 6, 2019

Author:

Liang Ding

Constructor Summary

Constructors

Constructor and Description
AbstractRepository(String name) Constructs a repository with the specified name.

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.
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.
protected Repository	getUnderlyingRepository() Gets the underlying repository.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.b3log.latke.repository.Repository

getFirst, getList

Constructor Detail

AbstractRepository

public AbstractRepository(String name)

Constructs a repository with the specified name.

Parameters:

name - the specified name

Method Detail

add

public String add(JSONObject jsonObject)
           throws RepositoryException

Description copied from interface: Repository

Adds the specified json object.

Specified by:

add in interface Repository

Parameters:

jsonObject - the specified json object

Returns:

the generated object id

Throws:

RepositoryException - repository exception

update

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

Description copied from interface: Repository

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

Specified by:

update in interface Repository

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

public void remove(String id)
            throws RepositoryException

Description copied from interface: Repository

Removes a json object by the specified id.

Specified by:

remove in interface Repository

Parameters:

id - the specified id

Throws:

RepositoryException - repository exception

remove

public void remove(Query query)
            throws RepositoryException

Description copied from interface: Repository

Removes json objects by the specified query.

Specified by:

remove in interface Repository

Parameters:

query - the specified query

Throws:

RepositoryException - repository exception

get

public JSONObject get(String id)
               throws RepositoryException

Description copied from interface: Repository

Gets a json object by the specified id.

Specified by:

get in interface Repository

Parameters:

id - the specified id

Returns:

a json object, returns null if not found

Throws:

RepositoryException - repository exception

get

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

Description copied from interface: Repository

Gets json objects by the specified ids.

Specified by:

get in interface Repository

Parameters:

ids - the specified ids

Returns:

json objects matched in the specified ids

Throws:

RepositoryException - repository exception

has

public boolean has(String id)
            throws RepositoryException

Description copied from interface: Repository

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

Specified by:

has in interface Repository

Parameters:

id - the given id

Returns:

true if it exists, otherwise false

Throws:

RepositoryException - repository exception

get

public JSONObject get(Query query)
               throws RepositoryException

Description copied from interface: Repository

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.

Specified by:

get in interface Repository

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

select

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

Description copied from interface: Repository

Gets json objects by the specified query statement.

Specified by:

select in interface Repository

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

public List<JSONObject> getRandomly(int fetchSize)
                             throws RepositoryException

Description copied from interface: Repository

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

Specified by:

getRandomly in interface Repository

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

public long count()
           throws RepositoryException

Description copied from interface: Repository

Gets the count of all json objects.

Specified by:

count in interface Repository

Returns:

count, returns -1 if not available

Throws:

RepositoryException - repository exception

count

public long count(Query query)
           throws RepositoryException

Description copied from interface: Repository

Gets the count of json objects by the specified query.

Specified by:

count in interface Repository

Parameters:

query - the specified query

Returns:

count, returns -1 if not available

Throws:

RepositoryException - repository exception

beginTransaction

public Transaction beginTransaction()

Description copied from interface: Repository

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. Repository.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.

Specified by:

beginTransaction in interface Repository

Returns:

the transaction that was started.

hasTransactionBegun

public boolean hasTransactionBegun()

Description copied from interface: Repository

Whether the repository within a transaction.

Specified by:

hasTransactionBegun in interface Repository

Returns:

true if the repository within a transaction, returns false otherwise

getName

public String getName()

Description copied from interface: Repository

Gets the name of this repository.

Specified by:

getName in interface Repository

Returns:

the name of this repository

isWritable

public boolean isWritable()

Description copied from interface: Repository

Whether the repository is writable.

Specified by:

isWritable in interface Repository

Returns:

true if it is writable, returns false otherwise

setWritable

public void setWritable(boolean writable)

Description copied from interface: Repository

Sets whether the repository is writable with the specified flag.

Specified by:

setWritable in interface Repository

Parameters:

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

setDebug

public void setDebug(boolean debugEnabled)

Description copied from interface: Repository

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

Specified by:

setDebug in interface Repository

Parameters:

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

getUnderlyingRepository

protected Repository getUnderlyingRepository()

Gets the underlying repository.

Returns:

underlying repository