com.liferay.portal.service.persistence
Class ShardPersistenceImpl

java.lang.Object
  com.liferay.portal.service.persistence.impl.BasePersistenceImpl<Shard>
      com.liferay.portal.service.persistence.ShardPersistenceImpl

All Implemented Interfaces:

SessionFactory, BasePersistence<Shard>, ShardPersistence

public class ShardPersistenceImpl
extends BasePersistenceImpl<Shard>
implements ShardPersistence

The persistence implementation for the shard service.

Caching information and settings can be found in portal.properties

See Also:

ShardPersistence, ShardUtil

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Field Summary

static String	FINDER_CLASS_NAME_ENTITY
static String	FINDER_CLASS_NAME_LIST_WITH_PAGINATION
static String	FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION
static FinderPath	FINDER_PATH_COUNT_ALL
static FinderPath	FINDER_PATH_COUNT_BY_C_C
static FinderPath	FINDER_PATH_COUNT_BY_NAME
static FinderPath	FINDER_PATH_FETCH_BY_C_C
static FinderPath	FINDER_PATH_FETCH_BY_NAME
static FinderPath	FINDER_PATH_WITH_PAGINATION_FIND_ALL
static FinderPath	FINDER_PATH_WITHOUT_PAGINATION_FIND_ALL

Fields inherited from class com.liferay.portal.service.persistence.impl.BasePersistenceImpl

COUNT_COLUMN_NAME, FINDER_ARGS_EMPTY, listeners, ORDER_BY_ASC, ORDER_BY_ASC_HAS_NEXT, ORDER_BY_CLAUSE, ORDER_BY_DESC, ORDER_BY_DESC_HAS_NEXT, WHERE_AND, WHERE_GREATER_THAN, WHERE_GREATER_THAN_HAS_NEXT, WHERE_LESSER_THAN, WHERE_LESSER_THAN_HAS_NEXT, WHERE_OR

Constructor Summary

ShardPersistenceImpl()

Method Summary

void	afterPropertiesSet() Initializes the shard persistence.
void	cacheResult(List<Shard> shards) Caches the shards in the entity cache if it is enabled.
void	cacheResult(Shard shard) Caches the shard in the entity cache if it is enabled.
protected void	cacheUniqueFindersCache(Shard shard)
void	clearCache() Clears the cache for all shards.
void	clearCache(List<Shard> shards) Clears the cache for a List instances of this model.
void	clearCache(Shard shard) Clears the cache for the shard.
protected void	clearUniqueFindersCache(Shard shard)
int	countAll() Returns the number of shards.
int	countByC_C(long classNameId, long classPK) Returns the number of shards where classNameId = ? and classPK = ?.
int	countByName(String name) Returns the number of shards where name = ?.
Shard	create(long shardId) Creates a new shard with the primary key.
void	destroy()
Shard	fetchByC_C(long classNameId, long classPK) Returns the shard where classNameId = ? and classPK = ? or returns null if it could not be found.
Shard	fetchByC_C(long classNameId, long classPK, boolean retrieveFromCache) Returns the shard where classNameId = ? and classPK = ? or returns null if it could not be found, optionally using the finder cache.
Shard	fetchByName(String name) Returns the shard where name = ? or returns null if it could not be found.
Shard	fetchByName(String name, boolean retrieveFromCache) Returns the shard where name = ? or returns null if it could not be found, optionally using the finder cache.
Shard	fetchByPrimaryKey(long shardId) Returns the shard with the primary key or returns null if it could not be found.
Shard	fetchByPrimaryKey(Serializable primaryKey) Returns the shard with the primary key or returns null if it could not be found.
List<Shard>	findAll() Returns all the shards.
List<Shard>	findAll(int start, int end) Returns a range of all the shards.
List<Shard>	findAll(int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the shards.
Shard	findByC_C(long classNameId, long classPK) Returns the shard where classNameId = ? and classPK = ? or throws a NoSuchShardException if it could not be found.
Shard	findByName(String name) Returns the shard where name = ? or throws a NoSuchShardException if it could not be found.
Shard	findByPrimaryKey(long shardId) Returns the shard with the primary key or throws a NoSuchShardException if it could not be found.
Shard	findByPrimaryKey(Serializable primaryKey) Returns the shard with the primary key or throws a NoSuchModelException if it could not be found.
Shard	remove(long shardId) Removes the shard with the primary key from the database.
Shard	remove(Serializable primaryKey) Removes the shard with the primary key from the database.
void	removeAll() Removes all the shards from the database.
Shard	removeByC_C(long classNameId, long classPK) Removes the shard where classNameId = ? and classPK = ? from the database.
Shard	removeByName(String name) Removes the shard where name = ? from the database.
protected Shard	removeImpl(Shard shard) Removes the model instance from the database.
protected Shard	toUnwrappedModel(Shard shard)
Shard	updateImpl(Shard shard) Updates the model instance in the database or adds it if it does not yet exist.

Methods inherited from class com.liferay.portal.service.persistence.impl.BasePersistenceImpl

appendOrderByComparator, appendOrderByComparator, closeSession, countWithDynamicQuery, countWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, flush, getBadColumnNames, getClassLoader, getCurrentSession, getDataSource, getDB, getDialect, getListeners, getModelClass, openNewSession, openSession, processException, registerListener, remove, removeConjunction, setDataSource, setModelClass, setSessionFactory, unregisterListener, update, update, update, update, updateImpl

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence

closeSession, countWithDynamicQuery, countWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, flush, getCurrentSession, getDataSource, getListeners, getModelClass, openSession, processException, registerListener, remove, setDataSource, unregisterListener, update, update, update, update

Field Detail

FINDER_CLASS_NAME_ENTITY

public static final String FINDER_CLASS_NAME_ENTITY

FINDER_CLASS_NAME_LIST_WITH_PAGINATION

public static final String FINDER_CLASS_NAME_LIST_WITH_PAGINATION

FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION

public static final String FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION

FINDER_PATH_WITH_PAGINATION_FIND_ALL

public static final FinderPath FINDER_PATH_WITH_PAGINATION_FIND_ALL

FINDER_PATH_WITHOUT_PAGINATION_FIND_ALL

public static final FinderPath FINDER_PATH_WITHOUT_PAGINATION_FIND_ALL

FINDER_PATH_COUNT_ALL

public static final FinderPath FINDER_PATH_COUNT_ALL

FINDER_PATH_FETCH_BY_NAME

public static final FinderPath FINDER_PATH_FETCH_BY_NAME

FINDER_PATH_COUNT_BY_NAME

public static final FinderPath FINDER_PATH_COUNT_BY_NAME

FINDER_PATH_FETCH_BY_C_C

public static final FinderPath FINDER_PATH_FETCH_BY_C_C

FINDER_PATH_COUNT_BY_C_C

public static final FinderPath FINDER_PATH_COUNT_BY_C_C

Constructor Detail

ShardPersistenceImpl

public ShardPersistenceImpl()

Method Detail

findByName

public Shard findByName(String name)
                 throws NoSuchShardException,
                        SystemException

Returns the shard where name = ? or throws a NoSuchShardException if it could not be found.

Specified by:

findByName in interface ShardPersistence

Parameters:

name - the name

Returns:

the matching shard

Throws:

NoSuchShardException - if a matching shard could not be found

SystemException - if a system exception occurred

fetchByName

public Shard fetchByName(String name)
                  throws SystemException

Returns the shard where name = ? or returns null if it could not be found. Uses the finder cache.

Specified by:

fetchByName in interface ShardPersistence

Parameters:

name - the name

Returns:

the matching shard, or null if a matching shard could not be found

Throws:

SystemException - if a system exception occurred

fetchByName

public Shard fetchByName(String name,
                         boolean retrieveFromCache)
                  throws SystemException

Returns the shard where name = ? or returns null if it could not be found, optionally using the finder cache.

Specified by:

fetchByName in interface ShardPersistence

Parameters:

name - the name

retrieveFromCache - whether to use the finder cache

Returns:

the matching shard, or null if a matching shard could not be found

Throws:

SystemException - if a system exception occurred

removeByName

public Shard removeByName(String name)
                   throws NoSuchShardException,
                          SystemException

Removes the shard where name = ? from the database.

Specified by:

removeByName in interface ShardPersistence

Parameters:

name - the name

Returns:

the shard that was removed

Throws:

SystemException - if a system exception occurred

NoSuchShardException

countByName

public int countByName(String name)
                throws SystemException

Returns the number of shards where name = ?.

Specified by:

countByName in interface ShardPersistence

Parameters:

name - the name

Returns:

the number of matching shards

Throws:

SystemException - if a system exception occurred

findByC_C

public Shard findByC_C(long classNameId,
                       long classPK)
                throws NoSuchShardException,
                       SystemException

Returns the shard where classNameId = ? and classPK = ? or throws a NoSuchShardException if it could not be found.

Specified by:

findByC_C in interface ShardPersistence

Parameters:

classNameId - the class name ID

classPK - the class p k

Returns:

the matching shard

Throws:

NoSuchShardException - if a matching shard could not be found

SystemException - if a system exception occurred

fetchByC_C

public Shard fetchByC_C(long classNameId,
                        long classPK)
                 throws SystemException

Returns the shard where classNameId = ? and classPK = ? or returns null if it could not be found. Uses the finder cache.

Specified by:

fetchByC_C in interface ShardPersistence

Parameters:

classNameId - the class name ID

classPK - the class p k

Returns:

the matching shard, or null if a matching shard could not be found

Throws:

SystemException - if a system exception occurred

fetchByC_C

public Shard fetchByC_C(long classNameId,
                        long classPK,
                        boolean retrieveFromCache)
                 throws SystemException

Returns the shard where classNameId = ? and classPK = ? or returns null if it could not be found, optionally using the finder cache.

Specified by:

fetchByC_C in interface ShardPersistence

Parameters:

classNameId - the class name ID

classPK - the class p k

retrieveFromCache - whether to use the finder cache

Returns:

the matching shard, or null if a matching shard could not be found

Throws:

SystemException - if a system exception occurred

removeByC_C

public Shard removeByC_C(long classNameId,
                         long classPK)
                  throws NoSuchShardException,
                         SystemException

Removes the shard where classNameId = ? and classPK = ? from the database.

Specified by:

removeByC_C in interface ShardPersistence

Parameters:

classNameId - the class name ID

classPK - the class p k

Returns:

the shard that was removed

Throws:

SystemException - if a system exception occurred

NoSuchShardException

countByC_C

public int countByC_C(long classNameId,
                      long classPK)
               throws SystemException

Returns the number of shards where classNameId = ? and classPK = ?.

Specified by:

countByC_C in interface ShardPersistence

Parameters:

classNameId - the class name ID

classPK - the class p k

Returns:

the number of matching shards

Throws:

SystemException - if a system exception occurred

cacheResult

public void cacheResult(Shard shard)

Caches the shard in the entity cache if it is enabled.

Specified by:

cacheResult in interface ShardPersistence

Parameters:

shard - the shard

cacheResult

public void cacheResult(List<Shard> shards)

Caches the shards in the entity cache if it is enabled.

Specified by:

cacheResult in interface ShardPersistence

Parameters:

shards - the shards

clearCache

public void clearCache()

Clears the cache for all shards.

The EntityCache and FinderCache are both cleared by this method.

Specified by:

clearCache in interface BasePersistence<Shard>

Overrides:

clearCache in class BasePersistenceImpl<Shard>

clearCache

public void clearCache(Shard shard)

Clears the cache for the shard.

The EntityCache and FinderCache are both cleared by this method.

Specified by:

clearCache in interface BasePersistence<Shard>

Overrides:

clearCache in class BasePersistenceImpl<Shard>

Parameters:

shard - the instance of this model to clear the cache for

clearCache

public void clearCache(List<Shard> shards)

Description copied from interface: BasePersistence

Clears the cache for a List instances of this model.

The EntityCache and FinderCache are both cleared by this method.

Specified by:

clearCache in interface BasePersistence<Shard>

Overrides:

clearCache in class BasePersistenceImpl<Shard>

Parameters:

shards - the List instances of this model to clear the cache for

cacheUniqueFindersCache

protected void cacheUniqueFindersCache(Shard shard)

clearUniqueFindersCache

protected void clearUniqueFindersCache(Shard shard)

create

public Shard create(long shardId)

Creates a new shard with the primary key. Does not add the shard to the database.

Specified by:

create in interface ShardPersistence

Parameters:

shardId - the primary key for the new shard

Returns:

the new shard

remove

public Shard remove(long shardId)
             throws NoSuchShardException,
                    SystemException

Removes the shard with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:

remove in interface ShardPersistence

Parameters:

shardId - the primary key of the shard

Returns:

the shard that was removed

Throws:

NoSuchShardException - if a shard with the primary key could not be found

SystemException - if a system exception occurred

remove

public Shard remove(Serializable primaryKey)
             throws NoSuchShardException,
                    SystemException

Removes the shard with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:

remove in interface BasePersistence<Shard>

Overrides:

remove in class BasePersistenceImpl<Shard>

Parameters:

primaryKey - the primary key of the shard

Returns:

the shard that was removed

Throws:

NoSuchShardException - if a shard with the primary key could not be found

SystemException - if a system exception occurred

removeImpl

protected Shard removeImpl(Shard shard)
                    throws SystemException

Description copied from class: BasePersistenceImpl

Removes the model instance from the database. BasePersistenceImpl.update(BaseModel, boolean) depends on this method to implement the remove operation; it only notifies the model listeners.

Overrides:

removeImpl in class BasePersistenceImpl<Shard>

Parameters:

shard - the model instance to remove

Returns:

the model instance that was removed

Throws:

SystemException - if a system exception occurred

updateImpl

public Shard updateImpl(Shard shard)
                 throws SystemException

Description copied from class: BasePersistenceImpl

Updates the model instance in the database or adds it if it does not yet exist. BasePersistenceImpl.remove(BaseModel) depends on this method to implement the update operation; it only notifies the model listeners.

Specified by:

updateImpl in interface ShardPersistence

Overrides:

updateImpl in class BasePersistenceImpl<Shard>

Parameters:

shard - the model instance to update

Returns:

the model instance that was updated

Throws:

SystemException - if a system exception occurred

toUnwrappedModel

protected Shard toUnwrappedModel(Shard shard)

findByPrimaryKey

public Shard findByPrimaryKey(Serializable primaryKey)
                       throws NoSuchShardException,
                              SystemException

Returns the shard with the primary key or throws a NoSuchModelException if it could not be found.

Specified by:

findByPrimaryKey in interface BasePersistence<Shard>

Overrides:

findByPrimaryKey in class BasePersistenceImpl<Shard>

Parameters:

primaryKey - the primary key of the shard

Returns:

the shard

Throws:

NoSuchShardException - if a shard with the primary key could not be found

SystemException - if a system exception occurred

findByPrimaryKey

public Shard findByPrimaryKey(long shardId)
                       throws NoSuchShardException,
                              SystemException

Returns the shard with the primary key or throws a NoSuchShardException if it could not be found.

Specified by:

findByPrimaryKey in interface ShardPersistence

Parameters:

shardId - the primary key of the shard

Returns:

the shard

Throws:

NoSuchShardException - if a shard with the primary key could not be found

SystemException - if a system exception occurred

fetchByPrimaryKey

public Shard fetchByPrimaryKey(Serializable primaryKey)
                        throws SystemException

Returns the shard with the primary key or returns null if it could not be found.

Specified by:

fetchByPrimaryKey in interface BasePersistence<Shard>

Overrides:

fetchByPrimaryKey in class BasePersistenceImpl<Shard>

Parameters:

primaryKey - the primary key of the shard

Returns:

the shard, or null if a shard with the primary key could not be found

Throws:

SystemException - if a system exception occurred

fetchByPrimaryKey

public Shard fetchByPrimaryKey(long shardId)
                        throws SystemException

Returns the shard with the primary key or returns null if it could not be found.

Specified by:

fetchByPrimaryKey in interface ShardPersistence

Parameters:

shardId - the primary key of the shard

Returns:

the shard, or null if a shard with the primary key could not be found

Throws:

SystemException - if a system exception occurred

findAll

public List<Shard> findAll()
                    throws SystemException

Returns all the shards.

Specified by:

findAll in interface ShardPersistence

Returns:

the shards

Throws:

SystemException - if a system exception occurred

findAll

public List<Shard> findAll(int start,
                           int end)
                    throws SystemException

Returns a range of all the shards.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShardModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:

findAll in interface ShardPersistence

Parameters:

start - the lower bound of the range of shards

end - the upper bound of the range of shards (not inclusive)

Returns:

the range of shards

Throws:

SystemException - if a system exception occurred

findAll

public List<Shard> findAll(int start,
                           int end,
                           OrderByComparator orderByComparator)
                    throws SystemException

Returns an ordered range of all the shards.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShardModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:

findAll in interface ShardPersistence

Parameters:

start - the lower bound of the range of shards

end - the upper bound of the range of shards (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of shards

Throws:

SystemException - if a system exception occurred

removeAll

public void removeAll()
               throws SystemException

Removes all the shards from the database.

Specified by:

removeAll in interface ShardPersistence

Throws:

SystemException - if a system exception occurred

countAll

public int countAll()
             throws SystemException

Returns the number of shards.

Specified by:

countAll in interface ShardPersistence

Returns:

the number of shards

Throws:

SystemException - if a system exception occurred

afterPropertiesSet

public void afterPropertiesSet()

Initializes the shard persistence.

destroy

public void destroy()