Liferay 6.2-ce-ga5

com.liferay.portal.service.persistence.impl
Class BasePersistenceImpl<T extends BaseModel<T>>

java.lang.Object
  extended by com.liferay.portal.service.persistence.impl.BasePersistenceImpl<T>
All Implemented Interfaces:
SessionFactory, BasePersistence<T>

public class BasePersistenceImpl<T extends BaseModel<T>>
extends Object
implements BasePersistence<T>, SessionFactory

The base implementation for all persistence classes. This class should never need to be used directly.

Caching information and settings can be found in portal.properties


Field Summary
static String COUNT_COLUMN_NAME
           
protected static Object[] FINDER_ARGS_EMPTY
           
protected  ModelListener<T>[] listeners
           
protected static String ORDER_BY_ASC
           
protected static String ORDER_BY_ASC_HAS_NEXT
           
protected static String ORDER_BY_CLAUSE
           
protected static String ORDER_BY_DESC
           
protected static String ORDER_BY_DESC_HAS_NEXT
           
protected static String WHERE_AND
           
protected static String WHERE_GREATER_THAN
           
protected static String WHERE_GREATER_THAN_HAS_NEXT
           
protected static String WHERE_LESSER_THAN
           
protected static String WHERE_LESSER_THAN_HAS_NEXT
           
protected static String WHERE_OR
           
 
Constructor Summary
BasePersistenceImpl()
           
 
Method Summary
protected  void appendOrderByComparator(StringBundler query, String entityAlias, OrderByComparator orderByComparator)
           
protected  void appendOrderByComparator(StringBundler query, String entityAlias, OrderByComparator orderByComparator, boolean sqlQuery)
           
 void clearCache()
          Clears the cache for all instances of this model.
 void clearCache(List<T> model)
          Clears the cache for a List instances of this model.
 void clearCache(T model)
          Clears the cache for one instance of this model.
 void closeSession(Session session)
           
 long countWithDynamicQuery(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 long countWithDynamicQuery(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 T fetchByPrimaryKey(Serializable primaryKey)
          Returns the model instance with the primary key or returns null if it could not be found.
 T findByPrimaryKey(Serializable primaryKey)
          Returns the model instance with the primary key or throws a NoSuchModelException if it could not be found.
 List findWithDynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 void flush()
           
protected  Set<String> getBadColumnNames()
           
protected  ClassLoader getClassLoader()
           
 Session getCurrentSession()
           
 DataSource getDataSource()
          Returns the data source for this model.
 DB getDB()
           
 Dialect getDialect()
           
 ModelListener<T>[] getListeners()
          Returns the listeners registered for this model.
 Class<T> getModelClass()
           
 Session openNewSession(Connection connection)
           
 Session openSession()
           
 SystemException processException(Exception e)
           
 void registerListener(ModelListener<T> listener)
          Registers a new listener for this model.
 T remove(Serializable primaryKey)
          Removes the model instance with the primary key from the database.
 T remove(T model)
          Removes the model instance from the database.
protected static String removeConjunction(String sql)
           
protected  T removeImpl(T model)
          Removes the model instance from the database.
 void setDataSource(DataSource dataSource)
          Sets the data source for this model.
protected  void setModelClass(Class<T> modelClass)
           
 void setSessionFactory(SessionFactory sessionFactory)
           
 void unregisterListener(ModelListener<T> listener)
          Unregisters the model listener.
 T update(T model)
          Updates the model instance in the database or adds it if it does not yet exist.
 T update(T model, boolean merge)
          Deprecated. As of 6.2.0, replaced by update(BaseModel)}
 T update(T model, boolean merge, ServiceContext serviceContext)
          Deprecated. As of 6.2.0, replaced by update(BaseModel, ServiceContext)}
 T update(T model, ServiceContext serviceContext)
          Updates the model instance in the database or adds it if it does not yet exist, within a different service context.
protected  T updateImpl(T model)
          Updates the model instance in the database or adds it if it does not yet exist.
protected  T updateImpl(T model, boolean merge)
          Deprecated. As of 6.2.0, replaced by updateImpl(BaseModel)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COUNT_COLUMN_NAME

public static final String COUNT_COLUMN_NAME
See Also:
Constant Field Values

FINDER_ARGS_EMPTY

protected static final Object[] FINDER_ARGS_EMPTY

ORDER_BY_ASC

protected static final String ORDER_BY_ASC
See Also:
Constant Field Values

ORDER_BY_ASC_HAS_NEXT

protected static final String ORDER_BY_ASC_HAS_NEXT
See Also:
Constant Field Values

ORDER_BY_CLAUSE

protected static final String ORDER_BY_CLAUSE
See Also:
Constant Field Values

ORDER_BY_DESC

protected static final String ORDER_BY_DESC
See Also:
Constant Field Values

ORDER_BY_DESC_HAS_NEXT

protected static final String ORDER_BY_DESC_HAS_NEXT
See Also:
Constant Field Values

WHERE_AND

protected static final String WHERE_AND
See Also:
Constant Field Values

WHERE_GREATER_THAN

protected static final String WHERE_GREATER_THAN
See Also:
Constant Field Values

WHERE_GREATER_THAN_HAS_NEXT

protected static final String WHERE_GREATER_THAN_HAS_NEXT
See Also:
Constant Field Values

WHERE_LESSER_THAN

protected static final String WHERE_LESSER_THAN
See Also:
Constant Field Values

WHERE_LESSER_THAN_HAS_NEXT

protected static final String WHERE_LESSER_THAN_HAS_NEXT
See Also:
Constant Field Values

WHERE_OR

protected static final String WHERE_OR
See Also:
Constant Field Values

listeners

protected ModelListener<T extends BaseModel<T>>[] listeners
Constructor Detail

BasePersistenceImpl

public BasePersistenceImpl()
Method Detail

clearCache

public void clearCache()
Description copied from interface: BasePersistence
Clears the cache for all instances of this model.

The EntityCache and FinderCache are both cleared by this method.

Specified by:
clearCache in interface BasePersistence<T extends BaseModel<T>>

clearCache

public void clearCache(List<T> model)
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<T extends BaseModel<T>>
Parameters:
model - the List instances of this model to clear the cache for

clearCache

public void clearCache(T model)
Description copied from interface: BasePersistence
Clears the cache for one instance of this model.

The EntityCache and FinderCache are both cleared by this method.

Specified by:
clearCache in interface BasePersistence<T extends BaseModel<T>>
Parameters:
model - the instance of this model to clear the cache for

closeSession

public void closeSession(Session session)
Specified by:
closeSession in interface SessionFactory
Specified by:
closeSession in interface BasePersistence<T extends BaseModel<T>>

countWithDynamicQuery

public long countWithDynamicQuery(DynamicQuery dynamicQuery)
                           throws SystemException
Description copied from interface: BasePersistence
Returns the number of rows that match the dynamic query.

Specified by:
countWithDynamicQuery in interface BasePersistence<T extends BaseModel<T>>
Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

countWithDynamicQuery

public long countWithDynamicQuery(DynamicQuery dynamicQuery,
                                  Projection projection)
                           throws SystemException
Description copied from interface: BasePersistence
Returns the number of rows that match the dynamic query.

Specified by:
countWithDynamicQuery in interface BasePersistence<T extends BaseModel<T>>
Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchByPrimaryKey

public T fetchByPrimaryKey(Serializable primaryKey)
                                         throws SystemException
Description copied from interface: BasePersistence
Returns the model instance with the primary key or returns null if it could not be found.

Specified by:
fetchByPrimaryKey in interface BasePersistence<T extends BaseModel<T>>
Parameters:
primaryKey - the primary key of the model instance
Returns:
the model instance, or null if an instance of this model with the primary key could not be found
Throws:
SystemException - if the primary key is null, or if a system exception occurred

findByPrimaryKey

public T findByPrimaryKey(Serializable primaryKey)
                                        throws NoSuchModelException,
                                               SystemException
Description copied from interface: BasePersistence
Returns the model instance with the primary key or throws a NoSuchModelException if it could not be found.

Specified by:
findByPrimaryKey in interface BasePersistence<T extends BaseModel<T>>
Parameters:
primaryKey - the primary key of the model instance
Returns:
the model instance
Throws:
NoSuchModelException - if an instance of this model with the primary key could not be found
SystemException - if the primary key is null, or if a system exception occurred

findWithDynamicQuery

public List findWithDynamicQuery(DynamicQuery dynamicQuery)
                          throws SystemException
Description copied from interface: BasePersistence
Performs a dynamic query on the database and returns the matching rows.

Specified by:
findWithDynamicQuery in interface BasePersistence<T extends BaseModel<T>>
Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

findWithDynamicQuery

public List findWithDynamicQuery(DynamicQuery dynamicQuery,
                                 int start,
                                 int end)
                          throws SystemException
Description copied from interface: BasePersistence
Performs a dynamic query on the database and returns a range of the matching rows.

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.

Specified by:
findWithDynamicQuery in interface BasePersistence<T extends BaseModel<T>>
Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of matching rows
end - the upper bound of the range of matching rows (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred
See Also:
QueryUtil.list( com.liferay.portal.kernel.dao.orm.Query, com.liferay.portal.kernel.dao.orm.Dialect, int, int)

findWithDynamicQuery

public List findWithDynamicQuery(DynamicQuery dynamicQuery,
                                 int start,
                                 int end,
                                 OrderByComparator orderByComparator)
                          throws SystemException
Description copied from interface: BasePersistence
Performs a dynamic query on the database and returns an ordered range of the matching rows.

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.

Specified by:
findWithDynamicQuery in interface BasePersistence<T extends BaseModel<T>>
Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of matching rows
end - the upper bound of the range of matching rows (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

flush

public void flush()
           throws SystemException
Specified by:
flush in interface BasePersistence<T extends BaseModel<T>>
Throws:
SystemException

getCurrentSession

public Session getCurrentSession()
                          throws ORMException
Specified by:
getCurrentSession in interface SessionFactory
Specified by:
getCurrentSession in interface BasePersistence<T extends BaseModel<T>>
Throws:
ORMException

getDataSource

public DataSource getDataSource()
Description copied from interface: BasePersistence
Returns the data source for this model.

Specified by:
getDataSource in interface BasePersistence<T extends BaseModel<T>>
Returns:
the data source for this model
See Also:
BasePersistence.setDataSource(DataSource)

getDB

public DB getDB()

getDialect

public Dialect getDialect()
Specified by:
getDialect in interface SessionFactory

getListeners

public ModelListener<T>[] getListeners()
Description copied from interface: BasePersistence
Returns the listeners registered for this model.

Specified by:
getListeners in interface BasePersistence<T extends BaseModel<T>>
Returns:
the listeners registered for this model
See Also:
BasePersistence.registerListener(ModelListener)

getModelClass

public Class<T> getModelClass()
Specified by:
getModelClass in interface BasePersistence<T extends BaseModel<T>>

openNewSession

public Session openNewSession(Connection connection)
                       throws ORMException
Specified by:
openNewSession in interface SessionFactory
Throws:
ORMException

openSession

public Session openSession()
                    throws ORMException
Specified by:
openSession in interface SessionFactory
Specified by:
openSession in interface BasePersistence<T extends BaseModel<T>>
Throws:
ORMException

processException

public SystemException processException(Exception e)
Specified by:
processException in interface BasePersistence<T extends BaseModel<T>>

registerListener

public void registerListener(ModelListener<T> listener)
Description copied from interface: BasePersistence
Registers a new listener for this model.

A model listener is notified whenever a change is made to an instance of this model, such as when one is added, updated, or removed.

Specified by:
registerListener in interface BasePersistence<T extends BaseModel<T>>
Parameters:
listener - the model listener to register

remove

public T remove(Serializable primaryKey)
                              throws NoSuchModelException,
                                     SystemException
Description copied from interface: BasePersistence
Removes the model instance with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:
remove in interface BasePersistence<T extends BaseModel<T>>
Parameters:
primaryKey - the primary key of the model instance to remove
Returns:
the model instance that was removed
Throws:
NoSuchModelException - if an instance of this model with the primary key could not be found
SystemException - if a system exception occurred

remove

public T remove(T model)
                              throws SystemException
Description copied from interface: BasePersistence
Removes the model instance from the database. Also notifies the appropriate model listeners.

Specified by:
remove in interface BasePersistence<T extends BaseModel<T>>
Parameters:
model - the model instance to remove
Returns:
the model instance that was removed
Throws:
SystemException - if a system exception occurred

setDataSource

public void setDataSource(DataSource dataSource)
Description copied from interface: BasePersistence
Sets the data source for this model.

Specified by:
setDataSource in interface BasePersistence<T extends BaseModel<T>>
Parameters:
dataSource - the data source to use for this model

setSessionFactory

public void setSessionFactory(SessionFactory sessionFactory)

unregisterListener

public void unregisterListener(ModelListener<T> listener)
Description copied from interface: BasePersistence
Unregisters the model listener.

Specified by:
unregisterListener in interface BasePersistence<T extends BaseModel<T>>
Parameters:
listener - the model listener to unregister
See Also:
BasePersistence.registerListener(ModelListener)

update

public T update(T model)
                              throws SystemException
Description copied from interface: BasePersistence
Updates the model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Typically not called directly, use local service update model methods instead. For example, UserLocalServiceUtil.updateUser( com.liferay.portal.model.User).

Specified by:
update in interface BasePersistence<T extends BaseModel<T>>
Parameters:
model - the model instance to update
Returns:
the model instance that was updated
Throws:
SystemException - if a system exception occurred

update

public T update(T model,
                boolean merge)
                              throws SystemException
Deprecated. As of 6.2.0, replaced by update(BaseModel)}

Specified by:
update in interface BasePersistence<T extends BaseModel<T>>
Throws:
SystemException

update

public T update(T model,
                boolean merge,
                ServiceContext serviceContext)
                              throws SystemException
Deprecated. As of 6.2.0, replaced by update(BaseModel, ServiceContext)}

Specified by:
update in interface BasePersistence<T extends BaseModel<T>>
Throws:
SystemException

update

public T update(T model,
                ServiceContext serviceContext)
                              throws SystemException
Description copied from interface: BasePersistence
Updates the model instance in the database or adds it if it does not yet exist, within a different service context. Also notifies the appropriate model listeners.

Specified by:
update in interface BasePersistence<T extends BaseModel<T>>
Parameters:
model - the model instance to update
serviceContext - the service context to be applied
Returns:
the model instance that was updated
Throws:
SystemException - if a system exception occurred

removeConjunction

protected static String removeConjunction(String sql)

appendOrderByComparator

protected void appendOrderByComparator(StringBundler query,
                                       String entityAlias,
                                       OrderByComparator orderByComparator)

appendOrderByComparator

protected void appendOrderByComparator(StringBundler query,
                                       String entityAlias,
                                       OrderByComparator orderByComparator,
                                       boolean sqlQuery)

getBadColumnNames

protected Set<String> getBadColumnNames()

getClassLoader

protected ClassLoader getClassLoader()

removeImpl

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

Parameters:
model - the model instance to remove
Returns:
the model instance that was removed
Throws:
SystemException - if a system exception occurred

setModelClass

protected void setModelClass(Class<T> modelClass)

updateImpl

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

Parameters:
model - the model instance to update
Returns:
the model instance that was updated
Throws:
SystemException - if a system exception occurred

updateImpl

protected T updateImpl(T model,
                       boolean merge)
                                     throws SystemException
Deprecated. As of 6.2.0, replaced by updateImpl(BaseModel)

Throws:
SystemException

Liferay 6.2-ce-ga5