Interface Entity


public interface Entity
An Entity describes a table/view in the DB. Use reporting.xml to define entities
  • Method Details

    • getEntity

      static Entity getEntity(String key)
      get the Entity as described in reporting.xml
      Parameters:
      key -
      Returns:
    • getId

      String getId()
      Returns:
      the entity's id
    • getName

      String getName()
      Returns:
      the entity's name
    • getLocalizedName

      String getLocalizedName()
    • getAlias

      String getAlias()
      Returns:
      the entity's alias
    • getTable

      String getTable()
      Returns:
      the entity's tablename
    • getResource

      Resource getResource()
      Returns:
      the Resource used for i18n
    • getSelectionString

      String getSelectionString(String prefix, Query q)
      entities may have a hard-coded sql-condition.
      Parameters:
      prefix -
      q -
      Returns:
      the predefined condition for this entity
    • getAsDomElement

      Element getAsDomElement()
      Returns:
      the <entity> element as defined in reporting.xml
    • getType

      Class<?> getType()
      Returns:
      the Persistent type associated with this entity
    • getAttribute

      Attribute getAttribute(String attribute)
      Parameters:
      attribute - the attribute id
      Returns:
      the attribute with the given id
    • getAttributes

      Map<String,Attribute> getAttributes()
      Returns:
      all attributes registered with this entity