act.db.ModelBase Maven / Gradle / Ivy

Go to download
package act.db;

/*-
 * #%L
 * ACT Framework
 * %%
 * Copyright (C) 2014 - 2017 ActFramework
 * %%
 * 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.
 * #L%
 */

import act.app.App;
import act.inject.param.NoBind;
import org.osgl.$;
import org.osgl.util.E;
import org.osgl.util.Generics;
import org.osgl.util.S;

import java.lang.reflect.Type;
import java.util.List;

/**
 * The model base class
 * @param  the generic type of Model class
 * @param  the generic type of the ID (Key)
 */
@NoBind
public abstract class ModelBase
implements Model {

    protected transient Type idType;
    protected transient Type modelType;

    public ModelBase() {
        exploreTypes();
    }

    // for JSON deserialization
    public ID_TYPE getId() {
        return _id();
    }

    // for JSON deserialization
    public void setId(ID_TYPE id) {
        _id(id);
    }

    protected Class idType() {
        return Generics.classOf(idType);
    }

    protected Class modelType() {
        return Generics.classOf(modelType);
    }

    /**
     * Returns a {@link Dao} object that can operate on this entity of
     * the entities with the same type.
     *
     * Note this method needs to be enhanced by framework to be called
     *
     * @return the {@code Dao} object
     */
    public static 
    T dao() {
        throw E.unsupport("Please make sure you have Entity annotation tagged on your model class");
    }

    /**
     * Returns a {@link Dao} object that can operate on this entity of
     * the entities with the same type.
     *
     * Note this method needs to be enhanced by framework to be called
     *
     * @return the {@code Dao} object
     */
    public static 
    T dao(Class cls) {
        throw E.unsupport("Please make sure you have Entity annotation tagged on your model class");
    }

    @Override
    public int hashCode() {
        return $.hc(getClass(), _id());
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if ($.eq(obj.getClass(), getClass())) {
            Model that = (Model) obj;
            return $.eq(that._id(), this._id());
        }
        return false;
    }

    @Override
    public String toString() {
        return S.concat(getClass().getName(), "[", S.string(getId()), "]");
    }


    protected final MODEL_TYPE _me() {
        return (MODEL_TYPE)this;
    }

    private void exploreTypes() {
        List types = Generics.typeParamImplementations(getClass(), ModelBase.class);
        int sz = types.size();
        if (sz < 1) {
            return;
        }
        if (sz > 1) {
            modelType = types.get(1);
        }
        idType = types.get(0);
    }
}