LocationAction.java

/*
 * Copyright 2022 Global Crop Diversity Trust
 *
 * 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 org.gringlobal.model.community;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.Table;

import org.gringlobal.custom.validation.javax.CodeValueField;
import org.gringlobal.model.AbstractAction;
import org.gringlobal.model.Method;

import com.fasterxml.jackson.annotation.JsonIdentityInfo;
import com.fasterxml.jackson.annotation.JsonIdentityReference;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.ObjectIdGenerators;

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * Actions are performed on {@link Location}s.
 */
@Entity
@Table(name = "location_action")
@JsonIdentityInfo(scope = LocationAction.class, generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
@Getter
@Setter
@NoArgsConstructor
public class LocationAction extends AbstractAction<LocationAction> {
	private static final long serialVersionUID = 5125557433917495394L;

	@Override
	public String getActionGroupName() {
		return CommunityCodeValues.LOCATION_ACTION;
	}

	@Id
	@JsonProperty
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	@Column(name = "location_action_id", columnDefinition = "int")
	private Long id;

	@ManyToOne(fetch = FetchType.LAZY, cascade = {})
	@JoinColumn(name = "location_id", nullable = false, updatable = false)
	@JsonIdentityReference
	@JsonIdentityInfo(scope = Location.class, generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
	@JsonIgnoreProperties({ "ownedBy" })
	private Location location;

	@ManyToOne(fetch = FetchType.LAZY, cascade = {})
	@JoinColumn(name = "method_id")
	private Method method;

	public LocationAction(final Long id) {
		this.id = id;
	}

	@Override
	public Long getOwningEntityId() {
		return location == null ? null : location.getId();
	}

	@Override
	@CodeValueField(value = CommunityCodeValues.LOCATION_ACTION, indexed = true)
	public String getActionNameCode() {
		return this.actionNameCode;
	}

	@Override
	public void lazyLoad() {
		super.lazyLoad();

		lazyLoad(location);
		lazyLoad(this.method);
	}

	@Override
	public boolean canEqual(Object other) {
		return other instanceof LocationAction;
	}
}