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 Details

    • 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

    • settings

      private Map<String,​String> settings

  • Constructor Details

    • ContextData

      public ContextData()

  • Method Details

    • 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 this Context 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"

    • setSettings

      void setSettings​(Map<String,​String> settings)