@ProviderType
public class ExpandoColumnUtil
extends Object
ExpandoColumnPersistenceImpl
and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.
Caching information and settings can be found in portal.properties
ExpandoColumnPersistence
,
ExpandoColumnPersistenceImpl
Constructor and Description |
---|
ExpandoColumnUtil() |
Modifier and Type | Method and Description |
---|---|
static void |
cacheResult(ExpandoColumn expandoColumn)
Caches the expando column in the entity cache if it is enabled.
|
static void |
cacheResult(List<ExpandoColumn> expandoColumns)
Caches the expando columns in the entity cache if it is enabled.
|
static void |
clearCache() |
static void |
clearCache(ExpandoColumn expandoColumn) |
static int |
countAll()
Returns the number of expando columns.
|
static int |
countByT_N(long tableId,
String name)
Returns the number of expando columns where tableId = ? and name = ?.
|
static int |
countByT_N(long tableId,
String[] names)
Returns the number of expando columns where tableId = ? and name = any ?.
|
static int |
countByTableId(long tableId)
Returns the number of expando columns where tableId = ?.
|
static long |
countWithDynamicQuery(DynamicQuery dynamicQuery) |
static ExpandoColumn |
create(long columnId)
Creates a new expando column with the primary key.
|
static ExpandoColumn |
fetchByPrimaryKey(long columnId)
Returns the expando column with the primary key or returns
null if it could not be found. |
static Map<Serializable,ExpandoColumn> |
fetchByPrimaryKeys(Set<Serializable> primaryKeys) |
static ExpandoColumn |
fetchByT_N(long tableId,
String name)
Returns the expando column where tableId = ? and name = ? or returns
null if it could not be found. |
static ExpandoColumn |
fetchByT_N(long tableId,
String name,
boolean retrieveFromCache)
Returns the expando column where tableId = ? and name = ? or returns
null if it could not be found, optionally using the finder cache. |
static ExpandoColumn |
fetchByTableId_First(long tableId,
OrderByComparator<ExpandoColumn> orderByComparator)
Returns the first expando column in the ordered set where tableId = ?.
|
static ExpandoColumn |
fetchByTableId_Last(long tableId,
OrderByComparator<ExpandoColumn> orderByComparator)
Returns the last expando column in the ordered set where tableId = ?.
|
static int |
filterCountByT_N(long tableId,
String name)
Returns the number of expando columns that the user has permission to view where tableId = ? and name = ?.
|
static int |
filterCountByT_N(long tableId,
String[] names)
Returns the number of expando columns that the user has permission to view where tableId = ? and name = any ?.
|
static int |
filterCountByTableId(long tableId)
Returns the number of expando columns that the user has permission to view where tableId = ?.
|
static ExpandoColumn[] |
filterFindByTableId_PrevAndNext(long columnId,
long tableId,
OrderByComparator<ExpandoColumn> orderByComparator)
Returns the expando columns before and after the current expando column in the ordered set of expando columns that the user has permission to view where tableId = ?.
|
static List<ExpandoColumn> |
filterFindByTableId(long tableId)
Returns all the expando columns that the user has permission to view where tableId = ?.
|
static List<ExpandoColumn> |
filterFindByTableId(long tableId,
int start,
int end)
Returns a range of all the expando columns that the user has permission to view where tableId = ?.
|
static List<ExpandoColumn> |
filterFindByTableId(long tableId,
int start,
int end,
OrderByComparator<ExpandoColumn> orderByComparator)
Returns an ordered range of all the expando columns that the user has permissions to view where tableId = ?.
|
static List<ExpandoColumn> |
findAll()
Returns all the expando columns.
|
static List<ExpandoColumn> |
findAll(int start,
int end)
Returns a range of all the expando columns.
|
static List<ExpandoColumn> |
findAll(int start,
int end,
OrderByComparator<ExpandoColumn> orderByComparator)
Returns an ordered range of all the expando columns.
|
static List<ExpandoColumn> |
findAll(int start,
int end,
OrderByComparator<ExpandoColumn> orderByComparator,
boolean retrieveFromCache)
Returns an ordered range of all the expando columns.
|
static ExpandoColumn |
findByPrimaryKey(long columnId)
Returns the expando column with the primary key or throws a
NoSuchColumnException if it could not be found. |
static ExpandoColumn |
findByT_N(long tableId,
String name)
Returns the expando column where tableId = ? and name = ? or throws a
NoSuchColumnException if it could not be found. |
static List<ExpandoColumn> |
findByT_N(long tableId,
String[] names)
Returns all the expando columns where tableId = ? and name = any ?.
|
static List<ExpandoColumn> |
findByT_N(long tableId,
String[] names,
int start,
int end)
Returns a range of all the expando columns where tableId = ? and name = any ?.
|
static List<ExpandoColumn> |
findByT_N(long tableId,
String[] names,
int start,
int end,
OrderByComparator<ExpandoColumn> orderByComparator)
Returns an ordered range of all the expando columns where tableId = ? and name = any ?.
|
static List<ExpandoColumn> |
findByT_N(long tableId,
String[] names,
int start,
int end,
OrderByComparator<ExpandoColumn> orderByComparator,
boolean retrieveFromCache)
Returns an ordered range of all the expando columns where tableId = ? and name = ?, optionally using the finder cache.
|
static ExpandoColumn |
findByTableId_First(long tableId,
OrderByComparator<ExpandoColumn> orderByComparator)
Returns the first expando column in the ordered set where tableId = ?.
|
static ExpandoColumn |
findByTableId_Last(long tableId,
OrderByComparator<ExpandoColumn> orderByComparator)
Returns the last expando column in the ordered set where tableId = ?.
|
static ExpandoColumn[] |
findByTableId_PrevAndNext(long columnId,
long tableId,
OrderByComparator<ExpandoColumn> orderByComparator)
Returns the expando columns before and after the current expando column in the ordered set where tableId = ?.
|
static List<ExpandoColumn> |
findByTableId(long tableId)
Returns all the expando columns where tableId = ?.
|
static List<ExpandoColumn> |
findByTableId(long tableId,
int start,
int end)
Returns a range of all the expando columns where tableId = ?.
|
static List<ExpandoColumn> |
findByTableId(long tableId,
int start,
int end,
OrderByComparator<ExpandoColumn> orderByComparator)
Returns an ordered range of all the expando columns where tableId = ?.
|
static List<ExpandoColumn> |
findByTableId(long tableId,
int start,
int end,
OrderByComparator<ExpandoColumn> orderByComparator,
boolean retrieveFromCache)
Returns an ordered range of all the expando columns where tableId = ?.
|
static List<ExpandoColumn> |
findWithDynamicQuery(DynamicQuery dynamicQuery) |
static List<ExpandoColumn> |
findWithDynamicQuery(DynamicQuery dynamicQuery,
int start,
int end) |
static List<ExpandoColumn> |
findWithDynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<ExpandoColumn> orderByComparator) |
static Set<String> |
getBadColumnNames() |
static ExpandoColumnPersistence |
getPersistence() |
static ExpandoColumn |
remove(long columnId)
Removes the expando column with the primary key from the database.
|
static void |
removeAll()
Removes all the expando columns from the database.
|
static ExpandoColumn |
removeByT_N(long tableId,
String name)
Removes the expando column where tableId = ? and name = ? from the database.
|
static void |
removeByTableId(long tableId)
Removes all the expando columns where tableId = ? from the database.
|
static ExpandoColumn |
update(ExpandoColumn expandoColumn) |
static ExpandoColumn |
update(ExpandoColumn expandoColumn,
ServiceContext serviceContext) |
static ExpandoColumn |
updateImpl(ExpandoColumn expandoColumn) |
public static void clearCache()
BasePersistence.clearCache()
public static void clearCache(ExpandoColumn expandoColumn)
public static long countWithDynamicQuery(DynamicQuery dynamicQuery)
public static List<ExpandoColumn> findWithDynamicQuery(DynamicQuery dynamicQuery)
public static List<ExpandoColumn> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)
public static List<ExpandoColumn> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<ExpandoColumn> orderByComparator)
public static ExpandoColumn update(ExpandoColumn expandoColumn)
public static ExpandoColumn update(ExpandoColumn expandoColumn, ServiceContext serviceContext)
public static List<ExpandoColumn> findByTableId(long tableId)
tableId
- the table IDpublic static List<ExpandoColumn> findByTableId(long tableId, int start, int end)
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 ExpandoColumnModelImpl
. 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.
tableId
- the table IDstart
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)public static List<ExpandoColumn> findByTableId(long tableId, int start, int end, OrderByComparator<ExpandoColumn> orderByComparator)
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 ExpandoColumnModelImpl
. 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.
tableId
- the table IDstart
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static List<ExpandoColumn> findByTableId(long tableId, int start, int end, OrderByComparator<ExpandoColumn> orderByComparator, boolean retrieveFromCache)
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 ExpandoColumnModelImpl
. 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.
tableId
- the table IDstart
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)retrieveFromCache
- whether to retrieve from the finder cachepublic static ExpandoColumn findByTableId_First(long tableId, OrderByComparator<ExpandoColumn> orderByComparator) throws NoSuchColumnException
tableId
- the table IDorderByComparator
- the comparator to order the set by (optionally null
)NoSuchColumnException
- if a matching expando column could not be foundpublic static ExpandoColumn fetchByTableId_First(long tableId, OrderByComparator<ExpandoColumn> orderByComparator)
tableId
- the table IDorderByComparator
- the comparator to order the set by (optionally null
)null
if a matching expando column could not be foundpublic static ExpandoColumn findByTableId_Last(long tableId, OrderByComparator<ExpandoColumn> orderByComparator) throws NoSuchColumnException
tableId
- the table IDorderByComparator
- the comparator to order the set by (optionally null
)NoSuchColumnException
- if a matching expando column could not be foundpublic static ExpandoColumn fetchByTableId_Last(long tableId, OrderByComparator<ExpandoColumn> orderByComparator)
tableId
- the table IDorderByComparator
- the comparator to order the set by (optionally null
)null
if a matching expando column could not be foundpublic static ExpandoColumn[] findByTableId_PrevAndNext(long columnId, long tableId, OrderByComparator<ExpandoColumn> orderByComparator) throws NoSuchColumnException
columnId
- the primary key of the current expando columntableId
- the table IDorderByComparator
- the comparator to order the set by (optionally null
)NoSuchColumnException
- if a expando column with the primary key could not be foundpublic static List<ExpandoColumn> filterFindByTableId(long tableId)
tableId
- the table IDpublic static List<ExpandoColumn> filterFindByTableId(long tableId, int start, int end)
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 ExpandoColumnModelImpl
. 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.
tableId
- the table IDstart
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)public static List<ExpandoColumn> filterFindByTableId(long tableId, int start, int end, OrderByComparator<ExpandoColumn> orderByComparator)
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 ExpandoColumnModelImpl
. 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.
tableId
- the table IDstart
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static ExpandoColumn[] filterFindByTableId_PrevAndNext(long columnId, long tableId, OrderByComparator<ExpandoColumn> orderByComparator) throws NoSuchColumnException
columnId
- the primary key of the current expando columntableId
- the table IDorderByComparator
- the comparator to order the set by (optionally null
)NoSuchColumnException
- if a expando column with the primary key could not be foundpublic static void removeByTableId(long tableId)
tableId
- the table IDpublic static int countByTableId(long tableId)
tableId
- the table IDpublic static int filterCountByTableId(long tableId)
tableId
- the table IDpublic static List<ExpandoColumn> findByT_N(long tableId, String[] names)
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 ExpandoColumnModelImpl
. 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.
tableId
- the table IDnames
- the namespublic static List<ExpandoColumn> findByT_N(long tableId, String[] names, int start, int end)
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 ExpandoColumnModelImpl
. 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.
tableId
- the table IDnames
- the namesstart
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)public static List<ExpandoColumn> findByT_N(long tableId, String[] names, int start, int end, OrderByComparator<ExpandoColumn> orderByComparator)
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 ExpandoColumnModelImpl
. 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.
tableId
- the table IDnames
- the namesstart
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static List<ExpandoColumn> findByT_N(long tableId, String[] names, int start, int end, OrderByComparator<ExpandoColumn> orderByComparator, boolean retrieveFromCache)
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 ExpandoColumnModelImpl
. 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.
tableId
- the table IDname
- the namestart
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)retrieveFromCache
- whether to retrieve from the finder cachepublic static ExpandoColumn findByT_N(long tableId, String name) throws NoSuchColumnException
NoSuchColumnException
if it could not be found.tableId
- the table IDname
- the nameNoSuchColumnException
- if a matching expando column could not be foundpublic static ExpandoColumn fetchByT_N(long tableId, String name)
null
if it could not be found. Uses the finder cache.tableId
- the table IDname
- the namenull
if a matching expando column could not be foundpublic static ExpandoColumn fetchByT_N(long tableId, String name, boolean retrieveFromCache)
null
if it could not be found, optionally using the finder cache.tableId
- the table IDname
- the nameretrieveFromCache
- whether to retrieve from the finder cachenull
if a matching expando column could not be foundpublic static ExpandoColumn removeByT_N(long tableId, String name) throws NoSuchColumnException
tableId
- the table IDname
- the nameNoSuchColumnException
public static int countByT_N(long tableId, String name)
tableId
- the table IDname
- the namepublic static int countByT_N(long tableId, String[] names)
tableId
- the table IDnames
- the namespublic static int filterCountByT_N(long tableId, String name)
tableId
- the table IDname
- the namepublic static int filterCountByT_N(long tableId, String[] names)
tableId
- the table IDnames
- the namespublic static void cacheResult(ExpandoColumn expandoColumn)
expandoColumn
- the expando columnpublic static void cacheResult(List<ExpandoColumn> expandoColumns)
expandoColumns
- the expando columnspublic static ExpandoColumn create(long columnId)
columnId
- the primary key for the new expando columnpublic static ExpandoColumn remove(long columnId) throws NoSuchColumnException
columnId
- the primary key of the expando columnNoSuchColumnException
- if a expando column with the primary key could not be foundpublic static ExpandoColumn updateImpl(ExpandoColumn expandoColumn)
public static ExpandoColumn findByPrimaryKey(long columnId) throws NoSuchColumnException
NoSuchColumnException
if it could not be found.columnId
- the primary key of the expando columnNoSuchColumnException
- if a expando column with the primary key could not be foundpublic static ExpandoColumn fetchByPrimaryKey(long columnId)
null
if it could not be found.columnId
- the primary key of the expando columnnull
if a expando column with the primary key could not be foundpublic static Map<Serializable,ExpandoColumn> fetchByPrimaryKeys(Set<Serializable> primaryKeys)
public static List<ExpandoColumn> findAll()
public static List<ExpandoColumn> findAll(int start, int end)
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 ExpandoColumnModelImpl
. 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.
start
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)public static List<ExpandoColumn> findAll(int start, int end, OrderByComparator<ExpandoColumn> orderByComparator)
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 ExpandoColumnModelImpl
. 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.
start
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static List<ExpandoColumn> findAll(int start, int end, OrderByComparator<ExpandoColumn> orderByComparator, boolean retrieveFromCache)
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 ExpandoColumnModelImpl
. 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.
start
- the lower bound of the range of expando columnsend
- the upper bound of the range of expando columns (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)retrieveFromCache
- whether to retrieve from the finder cachepublic static void removeAll()
public static int countAll()
public static Set<String> getBadColumnNames()
public static ExpandoColumnPersistence getPersistence()