ch.agent.t2.time

Interface TimeDomainCatalog

All Known Implementing Classes:

DefaultTimeDomainCatalog, ImmutableTimeDomainCatalog

public interface TimeDomainCatalog

TimeDomainCatalog is an interface for retrieving TimeDomain objects. A time domain catalog makes it easier to ensure that there is only one domain with a given set of properties. A catalog provides built-in domains guaranteed to be available whenever the catalog is present. The labels of such domains can be used as external identifiers.

Author:

Jean-Paul Vetterli

See Also:

TimeDomainDefinition

Method Summary

Modifier and Type	Method and Description
Collection<TimeDomain>	get() Return all time domains defined in the catalog.
TimeDomain	get(String label) Return the time domain with the given label.
TimeDomain	get(TimeDomainDefinition definition) Return the time domain corresponding to the definition, ignoring the label.

Method Detail

get

TimeDomain get(TimeDomainDefinition definition)

Return the time domain corresponding to the definition, ignoring the label. When no suitable time domain is found in this catalog, the method returns null.

Parameters:

definition - a non-null time domain definition

Returns:

a time domain matching the definition or null

get

TimeDomain get(String label)
        throws T2Exception

Return the time domain with the given label. Throw an exception when not found.

Parameters:

label - non-null string

Returns:

a time domain

Throws:

T2Exception

get

Collection<TimeDomain> get()

Return all time domains defined in the catalog.

Returns:

the collection of time domains