Interface DefinitionsFactory

All Known Implementing Classes:
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.

  • Field Details

    • READER_IMPL_PROPERTY

      static final String READER_IMPL_PROPERTY
      Property name that specifies the implementation of the DefinitionsReader.
      See Also:
    • LOCALE_RESOLVER_IMPL_PROPERTY

      static final String LOCALE_RESOLVER_IMPL_PROPERTY
      Property name that specifies the implementation of LocaleResolver.
      See Also:
    • DEFINITIONS_CONFIG

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

      static final String DEFINITION_DAO_INIT_PARAM
      Constant representing the configuration parameter used to define the definition DAO to use.
      See Also:
  • Method Details

    • getDefinition

      Definition getDefinition(String name, 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.