Package org.faktorips.runtime.internal

Class Table<R>

java.lang.Object
org.faktorips.runtime.internal.Table<R>
All Implemented Interfaces:
ITable<R>
public abstract class Table<R> extends Object implements ITable<R>
The base class for all the generated table classes. The table content is read from a DOM element by means of the initFromXml(Element) method. This class provides methods that are used by the generated table classes to build up an in memory representation of the content so that clients of the generated table classes can effectively access the table content by means of the generated find methods.

Generated table classes have a java.util.Map or a org.faktorips.util.ReadOnlyBinaryRangeTree member variable for each of their find methods. These maps or trees get filled at initialization time and are accessed within the find methods. Maps are used as member variables if the value to return can be identified by means of a hash key. A hash key can consist of multiple fields of value types (e.g. integer, long, decimal). If the value to return is identified by a range of key values a tree is used as the data structure to efficiently retrieve the value from. If the key that identifies a value consists of a combination of hash keys and range fields a map is used that contains trees as values. Depending on the number of range fields a tree hierarchy is build up where the depth of the hierarchy is determined by the number of range fields. That means that each node of a tree contains another tree representing the next level.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.faktorips.values.InternationalString
    description
    The description for this table in all configured languages.
    protected List<R>
    rows
    Contains all rows of this table.

    Fields inherited from interface org.faktorips.runtime.ITable

    TAG_NAME

  • Constructor Summary

    Constructors
    Constructor
    Description
    Table()
    Default constructor for tables initialized from XML.
    Table(String qualifiedTableName)
    Constructor for tables created from code.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected abstract void
    addRow(List<String> columns, IRuntimeRepository productRepository)
    Is used by the generated class to retrieve the values for a single row.
    List<R>
    getAllRows()
    Returns all rows of this table.
    String
    getDescription(Locale locale)
     
    String
    getName()
    Returns the qualified name of this table.
    protected final void
    init()
     
    void
    initFromXml(InputStream is, IRuntimeRepository productRepository, String qualifiedTableName)
    Initializes this object with the data stored in the XML element.
    protected abstract void
    initKeyMaps()
    Is used by the generated classes to build up the the maps and trees that are used by the also generated find-methods.
    protected boolean
    isNull(Element valueElement)
    Is used by generated classes within the initKeyMaps() method to identify a null values.
    protected void
    performAdditionalInitializations()
    Template method to perform additional initializations.
    void
    setDescription(Locale locale, String newDescriptionText, IRuntimeRepository repository)
    Sets or updates the description for the given Locale.
    void
    setDescription(org.faktorips.values.InternationalString newDescription, IRuntimeRepository repository)
    Replaces the current multi-language description with the given InternationalString.
    String
    toString()
    Returns the String representation of up to ten of this table's rows.
    Element
    toXml(Document document)
    Creates an XML Element that represents this table's data.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • rows

      protected List<R> rows
      Contains all rows of this table.

    • description

      protected org.faktorips.values.InternationalString description
      The description for this table in all configured languages.

  • Constructor Details

    • Table

      public Table()
      Default constructor for tables initialized from XML.
      Since:
      23.6

    • Table

      public Table(String qualifiedTableName)
      Constructor for tables created from code.
      Since:
      23.6

  • Method Details

    • addRow

      protected abstract void addRow(List<String> columns, IRuntimeRepository productRepository)
      Is used by the generated class to retrieve the values for a single row.
      Parameters:
      columns - List of objects that contain the values.

    • initKeyMaps

      protected abstract void initKeyMaps()
      Is used by the generated classes to build up the the maps and trees that are used by the also generated find-methods.

    • initFromXml

      public void initFromXml(InputStream is, IRuntimeRepository productRepository, String qualifiedTableName) throws Exception
      Initializes this object with the data stored in the XML element.
      Throws:
      Exception

    • init

      protected final void init()

    • performAdditionalInitializations

      protected void performAdditionalInitializations()
      Template method to perform additional initializations. Is called during the initialization of the table (from XML), right after initKeyMaps().

      Subclasses may override to provide an implementation. The default implementation is empty, so no super-call is necessary.

    • isNull

      protected boolean isNull(Element valueElement)
      Is used by generated classes within the initKeyMaps() method to identify a null values.
      Parameters:
      valueElement - the element that contains the value for a field within a row
      Returns:
      true if the the isNull attribute contains true otherwise false

    • toString

      public String toString()
      Returns the String representation of up to ten of this table's rows.
      Overrides:
      toString in class Object

    • getName

      public String getName()
      Description copied from interface: ITable
      Returns the qualified name of this table.
      Specified by:
      getName in interface ITable<R>

    • getDescription

      public String getDescription(Locale locale)

    • setDescription

      public void setDescription(@NonNull Locale locale, @NonNull String newDescriptionText, @NonNull IRuntimeRepository repository)
      Description copied from interface: ITable
      Sets or updates the description for the given Locale.

      If the description for the locale already exists, it will be replaced. If no description exists, a new localized description entry will be added. If the table belongs to a read-only IRuntimeRepository, this method will throw an IllegalRepositoryModificationException.

      Specified by:
      setDescription in interface ITable<R>
      Parameters:
      locale - the locale for which the description is to be set (must not be null)
      newDescriptionText - the new description text for the given locale (must not be null)
      repository - the runtime repository containing the table (must not be null)

    • setDescription

      public void setDescription(@NonNull org.faktorips.values.InternationalString newDescription, @NonNull IRuntimeRepository repository)
      Description copied from interface: ITable
      Replaces the current multi-language description with the given InternationalString.

      This method will overwrite all existing localized descriptions. If the table belongs to a read-only IRuntimeRepository, this method will throw an IllegalRepositoryModificationException.

      Specified by:
      setDescription in interface ITable<R>
      Parameters:
      newDescription - the new internationalized description to set (must not be null)
      repository - the runtime repository containing the table (must not be null)

    • getAllRows

      public List<R> getAllRows()
      Description copied from interface: ITable
      Returns all rows of this table.
      Specified by:
      getAllRows in interface ITable<R>

    • toXml

      public Element toXml(Document document)
      Description copied from interface: ITable
      Creates an XML Element that represents this table's data.

      Throws an UnsupportedOperationException if the support for toXml ("Generate toXml Support") is not activated in the Faktor-IPS standard builder.

      Specified by:
      toXml in interface ITable<R>
      Parameters:
      document - a document, that can be used to create XML elements.