History.java

package com.psddev.cms.db;

import java.util.Collections;
import java.util.Date;
import java.util.Map;
import java.util.UUID;

import com.google.common.base.Strings;
import com.psddev.dari.db.Record;
import com.psddev.dari.db.Query;
import com.psddev.dari.db.State;
import com.psddev.dari.db.ObjectType;

import com.psddev.dari.util.ObjectUtils;
import com.psddev.dari.util.PaginatedResult;

/** Represents previous revisions of objects. */
public class History extends Record {

    @Indexed
    private String name;

    @Indexed
    private Date updateDate;

    @Indexed
    private ToolUser updateUser;

    @Indexed
    private ObjectType objectType;

    @Indexed
    private UUID objectId;

    @Raw
    private Map<String, Object> objectOriginals;

    private boolean lockIgnored;

    /** Creates a blank instance. */
    protected History() {
    }

    /** Creates an instance based on the given {@code object}. */
    public History(ToolUser user, Object object) {
        State objectState = State.getInstance(object);
        getState().setDatabase(objectState.getDatabase());
        this.updateDate = new Date();
        this.updateUser = user;
        this.objectType = objectState.getType();
        this.objectId = objectState.getId();
        this.objectOriginals = objectState.getSimpleValues();
    }

    /**
     * Returns a partial list of all the revisions of the object with the
     * given {@code objectId} within the given {@code offset} and
     * {@code limit}.
     */
    public static PaginatedResult<History> findByObjectId(ToolUser user, UUID objectId, long offset, int limit) {
        return Query
                .from(History.class)
                .where("objectId = ?", objectId)
                .sortDescending("updateDate")
                .select(offset, limit);
    }

    /** Returns this history's name. */
    public String getName() {
        return name;
    }

    /** Sets this history's name. */
    public void setName(String name) {
        this.name = name;
    }

    /** Returns the date when the object was updated. */
    public Date getUpdateDate() {
        return updateDate;
    }

    /** Returns the user that updated the object. */
    public ToolUser getUpdateUser() {
        return updateUser;
    }

    /** Returns the object's ID. */
    public UUID getObjectId() {
        return objectId;
    }

    /** Returns an unmodifiable map of all the original values. */
    public Map<String, Object> getObjectOriginals() {
        return objectOriginals == null
                ? Collections.<String, Object>emptyMap()
                : Collections.unmodifiableMap(objectOriginals);
    }

    public boolean isLockIgnored() {
        return lockIgnored;
    }

    public void setLockIgnored(boolean lockIgnored) {
        this.lockIgnored = lockIgnored;
    }

    @Indexed
    public String getObjectIdUpdateDate() {
        UUID objectId = getObjectId();

        if (objectId != null) {
            Date updateDate = getUpdateDate();

            if (updateDate != null) {
                return objectId.toString() + Strings.padStart(
                        Long.toString(getUpdateDate().getTime(), 36),
                        Long.toString(Long.MAX_VALUE, 36).length(),
                        ' ');
            }
        }

        return null;
    }

    /** Returns the object. */
    public Object getObject() {
        if (objectType == null) {
            return null;
        } else {
            Object object = objectType.createObject(objectId);
            State state = State.getInstance(object);
            if (objectOriginals != null) {
                state.getValues().putAll(objectOriginals);
            }
            return object;
        }
    }

    @Override
    public String getLabel() {
        StringBuilder label = new StringBuilder();
        String name = getName();
        Date updateDate = getUpdateDate();
        ToolUser updateUser = getUpdateUser();

        if (!ObjectUtils.isBlank(name)) {
            label.append(name);
            label.append(" - ");
        }

        if (updateDate != null) {
            label.append(Localization.currentUserDate(updateDate.getTime(), Localization.DATE_AND_TIME_SKELETON));
        }

        if (updateUser != null) {
            label.append(" by ");
            label.append(updateUser.getLabel());
        }

        if (isLockIgnored()) {
            label.append(" (Lock Ignored)");
        }

        return label.toString();
    }
}