com.ocs.dynamo.functional.domain.Domain Maven / Gradle / Ivy

Go to download
/*
   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 com.ocs.dynamo.functional.domain;

import java.util.Objects;

import javax.persistence.Column;
import javax.persistence.DiscriminatorColumn;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.Inheritance;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

import org.apache.commons.lang3.builder.ReflectionToStringBuilder;

import com.ocs.dynamo.domain.AbstractEntity;
import com.ocs.dynamo.domain.model.EditableType;
import com.ocs.dynamo.domain.model.VisibilityType;
import com.ocs.dynamo.domain.model.annotation.Attribute;
import com.ocs.dynamo.domain.model.annotation.Model;
import com.ocs.dynamo.domain.model.annotation.SearchMode;
import com.ocs.dynamo.functional.DomainConstants;

/**
 * Base class for reference information.
 * 
 * @author Patrick Deenen ([email protected])
 *
 */
@Inheritance
@DiscriminatorColumn(name = "type")
@Entity(name = "domain")
@Model(displayProperty = "name", sortOrder = "name asc")
public abstract class Domain extends AbstractEntity {

	public static final String ATTRIBUTE_NAME = "name";

	public static final String ATTRIBUTE_CODE = "code";

	private static final long serialVersionUID = 1598343469161718498L;

	@Id
	private Integer id;

	@Attribute(visible = VisibilityType.HIDE, editable = EditableType.READ_ONLY)
	@Column(name = "type", insertable = false, updatable = false)
	private String type;

	/**
	 * By default, we only use "name" so the code is hidden
	 */
	@Attribute(visible = VisibilityType.HIDE)
	@Size(max = 5)
	private String code;

	@Size(max = 255)
	@NotNull
	@Attribute(main = true, maxLength = DomainConstants.MAX_NAME_LENGTH, searchable = SearchMode.ALWAYS)
	private String name;

	public Domain() {
	}

	/**
	 * Constructor
	 * 
	 * @param code
	 * @param name
	 */
	public Domain(final String code, final String name) {
		this.code = code;
		this.name = name;
	}

	@Override
	public Integer getId() {
		return this.id;
	}

	@Override
	public void setId(final Integer id) {
		this.id = id;
	}

	public String getType() {
		return type;
	}

	public String getCode() {
		return this.code;
	}

	public void setCode(final String code) {
		this.code = code;
	}

	public String getName() {
		return this.name;
	}

	public void setName(final String name) {
		this.name = name;
	}

	@Override
	public int hashCode() {
		return Objects.hashCode(id);
	}

	@Override
	public boolean equals(final Object obj) {
		if (this == obj) {
			return true;
		}
		if (!(obj instanceof Domain)) {
			return false;
		}

		if (!this.getClass().equals(obj.getClass())) {
			return false;
		}

		final Domain other = (Domain) obj;
		if (this.id != null && other.id != null) {
			// first, check if the IDs match
			return Objects.equals(this.id, other.id);
		} else {
			// if this is not the case, check for code and type
			return Objects.equals(this.code, other.code);
		}

	}

	@Override
	public String toString() {
		return ReflectionToStringBuilder.toStringExclude(this, "parent");
	}
}