org.vertexium.mutation.ExistingElementMutation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertexium-core Show documentation
There is a newer version: 4.10.0
package org.vertexium.mutation;

import org.vertexium.Element;
import org.vertexium.Property;
import org.vertexium.Visibility;

import java.util.List;

public interface ExistingElementMutation extends ElementMutation {
    /**
     * Alters the visibility of a property.
     *
     * @param property   The property to mutate.
     * @param visibility The new visibility.
     */
    default ExistingElementMutation alterPropertyVisibility(Property property, Visibility visibility) {
        return alterPropertyVisibility(property, visibility, null);
    }

    /**
     * Alters the visibility of a property.
     *
     * @param property   The property to mutate.
     * @param visibility The new visibility.
     * @param eventData  Data to store with the alter visibility
     */
    ExistingElementMutation alterPropertyVisibility(Property property, Visibility visibility, Object eventData);

    /**
     * Alters the visibility of a property.
     *
     * @param key        The key of a multivalued property.
     * @param name       The name of the property to alter the visibility of.
     * @param visibility The new visibility.
     */
    default ExistingElementMutation alterPropertyVisibility(String key, String name, Visibility visibility) {
        return alterPropertyVisibility(key, name, visibility, null);
    }

    /**
     * Alters the visibility of a property.
     *
     * @param key        The key of a multivalued property.
     * @param name       The name of the property to alter the visibility of.
     * @param visibility The new visibility.
     * @param eventData  Data to store with the alter visibility
     */
    ExistingElementMutation alterPropertyVisibility(String key, String name, Visibility visibility, Object eventData);

    /**
     * Alters the visibility of a property (assumes the property key is the DEFAULT).
     *
     * @param name       The name of the property to alter the visibility of.
     * @param visibility The new visibility.
     */
    default ExistingElementMutation alterPropertyVisibility(String name, Visibility visibility) {
        return alterPropertyVisibility(name, visibility, null);
    }

    /**
     * Alters the visibility of a property (assumes the property key is the DEFAULT).
     *
     * @param name       The name of the property to alter the visibility of.
     * @param visibility The new visibility.
     * @param eventData  Data to store with the alter visibility
     */
    ExistingElementMutation alterPropertyVisibility(String name, Visibility visibility, Object eventData);

    /**
     * Gets the properties whose visibilities are being altered in this mutation.
     */
    List getAlterPropertyVisibilities();

    /**
     * Alters the visibility of the element (vertex or edge).
     *
     * @param visibility The new visibility.
     */
    default ExistingElementMutation alterElementVisibility(Visibility visibility) {
        return alterElementVisibility(visibility, null);
    }

    /**
     * Alters the visibility of the element (vertex or edge).
     *
     * @param visibility The new visibility.
     * @param eventData  Data to store with the alter visibility
     */
    ExistingElementMutation alterElementVisibility(Visibility visibility, Object eventData);

    /**
     * Get the new element visibility or null if not being altered in this mutation.
     */
    Visibility getNewElementVisibility();

    /**
     * Get the data associated with the new element visibility. See {@link #getNewElementVisibility}
     */
    Object getNewElementVisibilityData();

    /**
     * Get the old element visibility.
     */
    Visibility getOldElementVisibility();

    /**
     * Sets a property metadata value on a property.
     *
     * @param property     The property to mutate.
     * @param metadataName The name of the metadata.
     * @param newValue     The new value.
     * @param visibility   The visibility of the metadata item
     */
    ExistingElementMutation setPropertyMetadata(Property property, String metadataName, Object newValue, Visibility visibility);

    /**
     * Sets a property metadata value on a property.
     *
     * @param propertyKey  The key of a multivalued property.
     * @param propertyName The name of the property.
     * @param metadataName The name of the metadata.
     * @param newValue     The new value.
     * @param visibility   The visibility of the metadata item
     */
    ExistingElementMutation setPropertyMetadata(String propertyKey, String propertyName, String metadataName, Object newValue, Visibility visibility);

    /**
     * Sets a property metadata value on a property.
     *
     * @param propertyName The name of the property.
     * @param metadataName The name of the metadata.
     * @param newValue     The new value.
     * @param visibility   The visibility of the metadata item
     */
    ExistingElementMutation setPropertyMetadata(String propertyName, String metadataName, Object newValue, Visibility visibility);

    /**
     * Gets all of the property metadata changes that are part of this mutation.
     */
    List getSetPropertyMetadatas();

    /**
     * Permanently deletes all default properties with that name irregardless of visibility.
     *
     * @param name the property name to delete.
     */
    ExistingElementMutation deleteProperties(String name);

    /**
     * Permanently deletes all properties with this key and name irregardless of visibility.
     *
     * @param key  the key of the property to delete.
     * @param name the name of the property to delete.
     */
    ExistingElementMutation deleteProperties(String key, String name);

    /**
     * Soft deletes all default properties with that name irregardless of visibility.
     *
     * @param name the property name to delete.
     */
    default ExistingElementMutation softDeleteProperties(String name) {
        return softDeleteProperties(name, (Object) null);
    }

    /**
     * Soft deletes all default properties with that name irregardless of visibility.
     *
     * @param name      the property name to delete.
     * @param eventData Data to store with the soft delete
     */
    ExistingElementMutation softDeleteProperties(String name, Object eventData);

    /**
     * Soft deletes all properties with this key and name irregardless of visibility.
     *
     * @param key  the key of the property to delete.
     * @param name the name of the property to delete.
     */
    default ExistingElementMutation softDeleteProperties(String key, String name) {
        return softDeleteProperties(key, name, null);
    }

    /**
     * Soft deletes all properties with this key and name irregardless of visibility.
     *
     * @param key       the key of the property to delete.
     * @param name      the name of the property to delete.
     * @param eventData Data to store with the soft delete
     */
    ExistingElementMutation softDeleteProperties(String key, String name, Object eventData);

    /**
     * Gets the element this mutation is affecting.
     *
     * @return The element.
     */
    T getElement();
}