Doc.java

/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - info@scireum.de
 */

package sirius.db.mongo;

import org.bson.Document;
import sirius.db.mixing.Mapping;
import sirius.kernel.commons.Strings;
import sirius.kernel.commons.Value;

import javax.annotation.Nonnull;
import java.util.Collections;
import java.util.List;

/**
 * A simple wrapper of a document in Mongo DB.
 */
public class Doc {

    private Document obj;

    /**
     * Wraps a result from Mongo DB
     *
     * @param obj the document or object to wrap
     */
    @SuppressWarnings("AssignmentOrReturnOfFieldWithMutableType")
    public Doc(Document obj) {
        this.obj = obj;
    }

    /**
     * Returns the ID of the document
     *
     * @return the id as assigned by mongo db
     */
    public String id() {
        return String.valueOf(obj.get(Mango.ID_FIELD));
    }

    /**
     * Returns the value of the requested field wrapped as {@link Value}.
     *
     * @param field the field to fetch
     * @return the value for the given field
     */
    public Value get(String field) {
        return Value.of(obj.get(field));
    }

    /**
     * Returns the value of the requested field wrapped as {@link Value}.
     *
     * @param field the field to fetch
     * @return the value for the given field
     */
    public Value get(Mapping field) {
        return Value.of(obj.get(field.toString()));
    }

    /**
     * Returns the string contents of the given field
     *
     * @param field the field to fetch
     * @return the string contents or "" if the field is empty
     */
    @Nonnull
    public String getString(String field) {
        return get(field).asString();
    }

    /**
     * Returns the string contents of the given field
     *
     * @param field the field to fetch
     * @return the string contents or "" if the field is empty
     */
    @Nonnull
    public String getString(Mapping field) {
        return get(field).asString();
    }

    /**
     * Returns the list contained in the given field
     *
     * @param field the field to fetch
     * @return the list contained in the given field or an empty list, if the field was empty
     */
    @SuppressWarnings("unchecked")
    public List<Object> getList(String field) {
        Object result = obj.get(field);
        return result == null ? Collections.emptyList() : (List<Object>) result;
    }

    /**
     * Returns the list contained in the given field
     *
     * @param field the field to fetch
     * @return the list contained in the given field or an empty list, if the field was empty
     */
    public List<Object> getList(Mapping field) {
        return getList(field.toString());
    }

    /**
     * Returns the list of strings contained in the given field
     *
     * @param field the field to fetch
     * @return the list contained in the given field or an empty list, if the field was empty
     */
    @SuppressWarnings("unchecked")
    public List<String> getStringList(String field) {
        return (List<String>) (Object) getList(field);
    }

    /**
     * Returns the list of strings contained in the given field
     *
     * @param field the field to fetch
     * @return the list contained in the given field or an empty list, if the field was empty
     */
    public List<String> getStringList(Mapping field) {
        return getStringList(field.toString());
    }

    /**
     * Returns the object stored for the given field.
     * <p>
     * If there is no object present or the given field doesn't contain an object, an empty readonly instance is returned.
     *
     * @param field the field to read
     * @return the object stored for the field
     */
    @SuppressWarnings("AssignmentOrReturnOfFieldWithMutableType")
    public Document getObject(String field) {
        Object result = get(field).get();
        if (result instanceof Document document) {
            return document;
        }

        return ReadonlyObject.EMPTY_OBJECT;
    }

    /**
     * Returns the object stored for the given field.
     * <p>
     * If there is no object present or the given field doesn't contain an object, an empty readonly instance is returned.
     *
     * @param field the field to read
     * @return the object stored for the field
     */
    public Document getObject(Mapping field) {
        return getObject(field.toString());
    }

    /**
     * Returns the inner value stored in the object in the given field.
     *
     * @param field the field to read the object from
     * @param key   the key to read from the object
     * @return the value within the inner object wrapped as {@link Value}
     */
    public Value getValueInObject(String field, String key) {
        if (Strings.isEmpty(key)) {
            return Value.EMPTY;
        }

        return Value.of(getObject(field).get(key));
    }

    /**
     * Returns the inner value stored in the object in the given field.
     *
     * @param field the field to read the object from
     * @param key   the key to read from the object
     * @return the value within the inner object wrapped as {@link Value}
     */
    public Value getValueInObject(Mapping field, String key) {
        return getValueInObject(field.toString(), key);
    }

    /**
     * Updates the underlying object, without updating the database.
     * <p>
     * This can be used to enhance an existing object after an update for further consumers. This is not intended to
     * update or modify the database in any way. Use {@link Mongo#update()} instead.
     *
     * @param key   the field to update
     * @param value the new value for the field
     */
    public void put(String key, Object value) {
        obj.put(key, value);
    }

    /**
     * Updates the underlying object, without updating the database.
     * <p>
     * This can be used to enhance an existing object after an update for further consumers. This is not intended to
     * update or modify the database in any way. Use {@link Mongo#update()} instead.
     *
     * @param key   the field to update
     * @param value the new value for the field
     */
    public void put(Mapping key, Object value) {
        obj.put(key.toString(), value);
    }

    @Override
    public String toString() {
        return obj == null ? "null" : obj.toString();
    }

    /**
     * Retruns the underlying Mongo DB Obect.
     *
     * @return the underlying object
     */
    @SuppressWarnings("AssignmentOrReturnOfFieldWithMutableType")
    public Document getUnderlyingObject() {
        return obj;
    }
}