Interface DefinitionsFactory

  • All Known Implementing Classes:
    LocaleDefinitionsFactory, UnresolvingLocaleDefinitionsFactory

    public interface DefinitionsFactory
    Interface for creating a Definitions and managing their contents.

    DefinitionsFactory implementations are responsible for maintaining the data sources of Tiles configuration data and using the data to create Definitions sets. Implementations also know how to append locale-specific configuration data to an existing Definitions set.

    Version:
    $Rev: 833737 $ $Date: 2009-11-08 06:17:09 +1100 (Sun, 08 Nov 2009) $
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEFINITION_DAO_INIT_PARAM
      Constant representing the configuration parameter used to define the definition DAO to use.
      static java.lang.String DEFINITIONS_CONFIG
      Constant representing the configuration parameter used to define the tiles definition resources.
      static java.lang.String LOCALE_RESOLVER_IMPL_PROPERTY
      Property name that specifies the implementation of LocaleResolver.
      static java.lang.String READER_IMPL_PROPERTY
      Property name that specifies the implementation of the DefinitionsReader.
    • Field Detail

      • READER_IMPL_PROPERTY

        static final java.lang.String READER_IMPL_PROPERTY
        Property name that specifies the implementation of the DefinitionsReader.
        See Also:
        Constant Field Values
      • LOCALE_RESOLVER_IMPL_PROPERTY

        static final java.lang.String LOCALE_RESOLVER_IMPL_PROPERTY
        Property name that specifies the implementation of LocaleResolver.
        See Also:
        Constant Field Values
      • DEFINITIONS_CONFIG

        static final java.lang.String DEFINITIONS_CONFIG
        Constant representing the configuration parameter used to define the tiles definition resources.
        Since:
        2.1.0
        See Also:
        Constant Field Values
      • DEFINITION_DAO_INIT_PARAM

        static final java.lang.String DEFINITION_DAO_INIT_PARAM
        Constant representing the configuration parameter used to define the definition DAO to use.
        See Also:
        Constant Field Values
    • Method Detail

      • getDefinition

        Definition getDefinition​(java.lang.String name,
                                 org.apache.tiles.request.Request tilesContext)
        Returns a Definition object that matches the given name and Tiles context.
        Parameters:
        name - The name of the Definition to return.
        tilesContext - The Tiles context to use to resolve the definition.
        Returns:
        the Definition matching the given name or null if none is found.