jetbrains.exodus.database.TransientChangesTracker Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2006 - 2017 JetBrains s.r.o.
 *
 * 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 jetbrains.exodus.database;

import jetbrains.exodus.entitystore.Entity;
import jetbrains.exodus.entitystore.PersistentStoreTransaction;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Map;
import java.util.Set;

public interface TransientChangesTracker {

    /**
     * Return description of all changes
     *
     * @return
     */
    @NotNull
    Set getChangesDescription();

    /**
     * Return size of the result of getChangesDescription
     *
     * @return
     */
    int getChangesDescriptionCount();

    /**
     * Return change description for given entity
     *
     * @param e
     * @return
     */
    TransientEntityChange getChangeDescription(TransientEntity e);

    /**
     * Returns set of changed links for given entity
     *
     * @param e
     * @return
     */
    @Nullable
    Map getChangedLinksDetailed(@NotNull TransientEntity e);

    /**
     * Returns set of changed properties for given entity
     *
     * @param e
     * @return
     */
    @Nullable
    Set getChangedProperties(@NotNull TransientEntity e);

    PersistentStoreTransaction getSnapshot();

    TransientEntity getSnapshotEntity(TransientEntity e);

    TransientChangesTracker upgrade();

    void dispose();

    Set getChangedEntities();

    Set getRemovedEntities();

    Set getAffectedEntityTypes();

    boolean isNew(TransientEntity e);

    boolean isSaved(TransientEntity transientEntity);

    boolean isRemoved(TransientEntity transientEntity);

    void linkChanged(TransientEntity source, String linkName, TransientEntity target, TransientEntity oldTarget, boolean add);

    void linksRemoved(TransientEntity source, String linkName, Iterable links);

    void propertyChanged(TransientEntity e, String propertyName);

    void removePropertyChanged(TransientEntity e, String propertyName);

    void entityAdded(TransientEntity e);

    void entityRemoved(TransientEntity e);
}