com.thesett.catalogue.model.Catalogue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of catalogue-model Show documentation
A catalogue which is confugurable at the knowledge level to catalogue and organise any type of data and to provide structured access to it, free text querying of it and automatic data warehousing of events relating to it.
There is a newer version: 0.9.65
Show newest version
/*
 * Copyright The Sett Ltd, 2005 to 2014.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.thesett.catalogue.model;

import java.util.Collection;
import java.util.List;
import java.util.Set;

import com.thesett.aima.attribute.impl.DateRangeType;
import com.thesett.aima.attribute.impl.EnumeratedStringAttribute;
import com.thesett.aima.attribute.impl.HierarchyType;
import com.thesett.aima.attribute.impl.TimeRangeType;
import com.thesett.aima.state.ComponentType;
import com.thesett.aima.state.Type;

/**
 * Catalogue is the root type of the knowledge level of a catalogue. It can be queried as to what {@link ComponentType}s
 * exist in the catalogue.
 *
 * 
 * CRC CardResponsibilities Collaborations
 * 
Report the contents of a catalogue.
 * 
 *
 * @author Rupert Smith
 */
public interface Catalogue
{
    /** The extension to add to a dimension name to get the name of the table in the online database. */
    String ONLINE_TABLE_EXT = "_Online";

    /** The extension to add to a hierarchy type name to get the name of the table in the online database. */
    String HIERARCHY_TABLE_EXT = "_hierarchy";

    /**
     * Provides the namespace that the catalogue package exists under.
     *
     * @return The namespace that the catalogue package exists under.
     */
    String getModelPackage();

    /**
     * Gets the hierarchy type of a named hierarchy type definition in the catalogue.
     *
     * @param  name The hierarchy type definition to get the type for.
     *
     * @return The hierarchies type or null if it is not part of this catalogue.
     */
    HierarchyType getHierarchyType(String name);

    /**
     * Gets the enumeration type of a named enumeration definition in the catalogue.
     *
     * @param  name The enumeration type definition to get the type for.
     *
     * @return The enumeration type of null if it is not part of this catalogue.
     */
    EnumeratedStringAttribute.EnumeratedStringType getEnumerationType(String name);

    /**
     * Gets the named component type from the catalogue.
     *
     * @param  name The name of the component type to retrieve.
     *
     * @return The component type, or null if none with a matching name can be found.
     */
    ComponentType getComponentType(String name);

    /**
     * Gets the named entity type from the catalogue.
     *
     * @param  name The name of the entity type to retrieve.
     *
     * @return The entity type, or null if none with a matching name can be found.
     */
    EntityType getEntityType(String name);

    /**
     * Gets the named dimension type from the catalogue.
     *
     * @param  name The name of the dimension type to retrieve.
     *
     * @return The dimension type, or null if none with a matching name can be found.
     */
    DimensionType getDimensionType(String name);

    /**
     * Gets the named fact type from the catalogue.
     *
     * @param  name The name of the fact type to retrieve.
     *
     * @return The fact type, or null if none with a matching name can be found.
     */
    FactType getFactType(String name);

    /**
     * Gets the named view type from the catalogue.
     *
     * @param  name The name of the view type to retrieve.
     *
     * @return The view type, or null if none with a matching name can be found.
     */
    ViewType getViewType(String name);

    /**
     * Gets the named date range type from the catalogue.
     *
     * @param  name The name of the date range type to retrieve.
     *
     * @return The date range type, or null if none with a matching name can be found.
     */
    DateRangeType getDateRangeType(String name);

    /**
     * Gets the named time range type from the catalogue.
     *
     * @param  name The name of the time range type to retrieve.
     *
     * @return The time range type, or null if none with a matching name can be found.
     */
    TimeRangeType getTimeRangeType(String name);

    /**
     * Lists all top-level types defined in the catalogue.
     *
     * @return A list of all top-level types defined in the catalogue.
     */
    Collection getAllTypes();

    /**
     * Gets all the hierarchy type definitions from the catalogue top level.
     *
     * @return A list of all the hierarchy type definitions from the catalogue top level.
     */
    Collection getAllHierarchyTypes();

    /**
     * Gets all the enumeration type definitions from the catalogue top level.
     *
     * @return A list of all the enumeration type definitions from the catalogue top level.
     */
    Collection getAllEnumTypes();

    /**
     * Lists all the component types in the catalogue.
     *
     * @return A list of all the component types in the catalogue.
     */
    Collection getAllComponentTypes();

    /**
     * Lists all the entity types in the catalogue.
     *
     * @return A list of all the entity types in the catalogue.
     */
    Collection getAllEntityTypes();

    /**
     * Reports the names of all free text indexes to which a dimension is indexed.
     *
     * @param  dimensionName The name of the dimension.
     *
     * @return A list of all the free text search indexes that the dimension is indexed by.
     */
    List getIndexesForDimension(String dimensionName);

    /**
     * Reports the names of all free text indexes in the catalogue.
     *
     * @return A list of all the free text search indexes in the catalogue.
     */
    Set getAllIndexes();
}