Package net.sf.basedb.core.data
Class ContextData
- java.lang.Object
-
- net.sf.basedb.core.data.BasicData
-
- net.sf.basedb.core.data.ContextData
-
- All Implemented Interfaces:
IdentifiableData
public class ContextData extends BasicData
This class holds context information to help client applications with storing common settings for tables.- Version:
- 2.0
- Author:
- Nicklas
- See Also:
ItemContext
, Developer documentation: Client, session and settings- Last modified
- $Date: 2014-06-10 13:27:02 +0200 (ti, 10 jun 2014) $
- Hibernate: class
- table="`Contexts`" lazy="true"
-
-
Field Summary
Fields Modifier and Type Field Description private ClientData
client
private int
include
private boolean
isPublic
private int
itemId
private int
itemType
static int
MAX_NAME_LENGTH
The maximum length of the name that can be stored in the database.static int
MAX_SORTPROPERTY_LENGTH
The maximum length of the sort order that can be stored in the database.static int
MAX_SUBCONTEXT_LENGTH
The maximum length of the name that can be stored in the database.private String
name
private int
page
private Map<String,PropertyFilterData>
propertyFilters
private int
rowsPerPage
private Map<String,String>
settings
private int
sortDirection
private String
sortProperty
private String
subContext
private UserData
user
-
Constructor Summary
Constructors Constructor Description ContextData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ClientData
getClient()
Get the client which uses this context.int
getInclude()
Flags for specifying include options to an entity query.int
getItemId()
Get the current item ID or 0 if no item is current.int
getItemType()
Get the item type this context is valid for.String
getName()
Get the name of thisContext
item.int
getPage()
Get the current page number, starting at 0.Map<String,PropertyFilterData>
getPropertyFilters()
Get the map that manages property filters in this context.int
getRowsPerPage()
Get the number of rows that are displayed on each table page.Map<String,String>
getSettings()
Get a map for other settings.int
getSortDirection()
Get the sort direction, 0 = ascending, 1 = descendingString
getSortProperty()
Get property name to sort on.String
getSubContext()
Get the subcontext this context belongs to.UserData
getUser()
Get the user that owns this context.boolean
isPublic()
If the settings are public (ie. can be used by anyone) or not.void
setClient(ClientData client)
void
setInclude(int include)
void
setItemId(int itemId)
void
setItemType(int itemType)
void
setName(String name)
void
setPage(int page)
(package private) void
setPropertyFilters(Map<String,PropertyFilterData> propertyFilters)
void
setPublic(boolean isPublic)
void
setRowsPerPage(int rowsPerPage)
(package private) void
setSettings(Map<String,String> settings)
void
setSortDirection(int sortDirection)
void
setSortProperty(String sortProperty)
void
setSubContext(String subContext)
void
setUser(UserData user)
-
Methods inherited from class net.sf.basedb.core.data.BasicData
equals, getId, getVersion, hashCode, setId, setVersion, toString
-
-
-
-
Field Detail
-
user
private UserData user
-
client
private ClientData client
-
MAX_NAME_LENGTH
public static final int MAX_NAME_LENGTH
The maximum length of the name that can be stored in the database.- See Also:
setName(String)
, Constant Field Values
-
name
private String name
-
itemType
private int itemType
-
MAX_SUBCONTEXT_LENGTH
public static final int MAX_SUBCONTEXT_LENGTH
The maximum length of the name that can be stored in the database.- See Also:
setName(String)
, Constant Field Values
-
subContext
private String subContext
-
isPublic
private boolean isPublic
-
rowsPerPage
private int rowsPerPage
-
itemId
private int itemId
-
page
private int page
-
MAX_SORTPROPERTY_LENGTH
public static final int MAX_SORTPROPERTY_LENGTH
The maximum length of the sort order that can be stored in the database.- See Also:
setSortProperty(String)
, Constant Field Values
-
sortProperty
private String sortProperty
-
sortDirection
private int sortDirection
-
include
private int include
-
propertyFilters
private Map<String,PropertyFilterData> propertyFilters
-
-
Method Detail
-
getUser
public UserData getUser()
Get the user that owns this context.- Hibernate: many-to-one
- column="`user_id`" not-null="true" update="false" outer-join="false" unique-key="Context_uniquecontext"
-
setUser
public void setUser(UserData user)
-
getClient
public ClientData getClient()
Get the client which uses this context.- Hibernate: many-to-one
- column="`client_id`" not-null="true" update="false" outer-join="false" unique-key="Context_uniquecontext"
-
setClient
public void setClient(ClientData client)
-
getName
public String getName()
Get the name of thisContext
item.- Hibernate: property
- column="`name`" type="string" length="255" not-null="true" update="true" unique-key="Context_uniquecontext"
-
setName
public void setName(String name)
-
getItemType
public int getItemType()
Get the item type this context is valid for.- Hibernate: property
- column="`item_type`" type="int" not-null="true" update="false" unique-key="Context_uniquecontext"
-
setItemType
public void setItemType(int itemType)
-
getSubContext
public String getSubContext()
Get the subcontext this context belongs to.- Hibernate: property
- column="`subcontext`" type="string" length="255" not-null="true" update="true" unique-key="Context_uniquecontext"
-
setSubContext
public void setSubContext(String subContext)
-
isPublic
public boolean isPublic()
If the settings are public (ie. can be used by anyone) or not.- Hibernate: property
- column="`is_public`" type="boolean"
-
setPublic
public void setPublic(boolean isPublic)
-
getRowsPerPage
public int getRowsPerPage()
Get the number of rows that are displayed on each table page.- Hibernate: property
- column="`rows_per_page`" type="int"
-
setRowsPerPage
public void setRowsPerPage(int rowsPerPage)
-
getItemId
public int getItemId()
Get the current item ID or 0 if no item is current.- Hibernate: property
- column="`item_id`" type="int"
-
setItemId
public void setItemId(int itemId)
-
getPage
public int getPage()
Get the current page number, starting at 0.- Hibernate: property
- column="`page`" type="int"
-
setPage
public void setPage(int page)
-
getSortProperty
public String getSortProperty()
Get property name to sort on.- Hibernate: property
- column="`sort_property`" type="string" length="255"
-
setSortProperty
public void setSortProperty(String sortProperty)
-
getSortDirection
public int getSortDirection()
Get the sort direction, 0 = ascending, 1 = descending- Hibernate: property
- column="`sort_direction`" type="int"
-
setSortDirection
public void setSortDirection(int sortDirection)
-
getInclude
public int getInclude()
Flags for specifying include options to an entity query.- Hibernate: property
- column="`include`" type="int"
-
setInclude
public void setInclude(int include)
-
getPropertyFilters
public Map<String,PropertyFilterData> getPropertyFilters()
Get the map that manages property filters in this context.- Hibernate: map
- table="`PropertyFilters`" lazy="true"
- Hibernate: collection-key
- column="`context_id`"
- Hibernate: collection-index
- column="`property`" type="string" length="255"
- Hibernate: collection-composite-element
- class="net.sf.basedb.core.data.PropertyFilterData" not-null="true"
-
setPropertyFilters
void setPropertyFilters(Map<String,PropertyFilterData> propertyFilters)
-
getSettings
public Map<String,String> getSettings()
Get a map for other settings.- Hibernate: map
- table="`ContextSettings`" lazy="true"
- Hibernate: collection-key
- column="`context_id`"
- Hibernate: collection-index
- column="`name`" type="string" length="255"
- Hibernate: collection-element
- column="`value`" type="text"
-
-