com.marklogic.hub.EntityManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of marklogic-data-hub Show documentation

Library for Creating an Operational Data Hub on MarkLogic

There is a newer version: 6.1.1

/*
 * Copyright (c) 2021 MarkLogic Corporation
 *
 * 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.marklogic.hub;

import com.marklogic.hub.entity.HubEntity;

import java.io.IOException;
import java.util.HashMap;
import java.util.List;

/**
 * Manages existing entities' MarkLogic Server database index settings and query options.
 */
public interface EntityManager {

    /**
     * Updates the query options to the file system
     *
     * @return boolean - if it fails to so, false is returned
     */
    boolean saveQueryOptions();

    /**
     * Deploys the query option
     *
     * @return hashmap - ENUM DatabaseKind of what database and boolean if the deploy was successful or not.
     */
    HashMap deployQueryOptions();

    /**
     * Updates the indexes for the entity on the filesystem
     *
     * @return boolean - if it fails to do so, false is returned
     */
    boolean saveDbIndexes();

    /**
     * Scans the entities in the project for pii properties, and saves the
     * required ELS configurations to support those properties.
     *
     * @return - true if successfully saved, false if it did not
     */
    boolean savePii();

    HubEntity getEntityFromProject(String entityName);

    HubEntity getEntityFromProject(String entityName, String version);

    HubEntity getEntityFromProject(String entityName, Boolean extendSubEntities);

    HubEntity getEntityFromProject(String entityName, String version, Boolean extendSubEntities);

    List getEntities();

    List getEntities(Boolean extendSubEntities);

    @Deprecated // since DHF 5.3.0; use ModelsService instead
    HubEntity saveEntity(HubEntity entity, Boolean rename) throws IOException;

    void deleteEntity(String entity) throws IOException;
}