RouteImpl.java

/*
 * Copyright 2005-2025 the original author or authors.
 *
 * 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.openwms.tms.routing;

import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.JoinColumn;
import jakarta.persistence.ManyToOne;
import jakarta.persistence.Table;
import jakarta.validation.constraints.NotBlank;
import org.ameba.integration.jpa.ApplicationEntity;

import java.beans.ConstructorProperties;
import java.util.Objects;

/**
 * A RouteImpl.
 *
 * @author Heiko Scherrer
 */
@Entity
@Table(name = "TMS_RSRV_ROUTE")
public class RouteImpl extends ApplicationEntity implements Route {

    /** For TransportUnits without active TransportOrder. */
    public static final Route NO_ROUTE = new RouteConst("_NO_ROUTE");
    /** For all TransportOrders with no explicitly defined Route. */
    public static final Route DEF_ROUTE = new RouteConst("_DEFAULT");
    @NotBlank
    @Column(name = "C_NAME", unique = true)
    private String routeId;
    @Column(name = "C_DESCRIPTION")
    private String description;
    @ManyToOne
    @JoinColumn(name = "C_SOURCE_LOCATION", referencedColumnName = "C_PK")
    private LocationEO sourceLocation;
    @ManyToOne
    @JoinColumn(name = "C_TARGET_LOCATION", referencedColumnName = "C_PK")
    private LocationEO targetLocation;
    @Column(name = "C_SOURCE_LOC_GROUP_NAME")
    private String sourceLocationGroupName;
    @Column(name = "C_TARGET_LOC_GROUP_NAME")
    private String targetLocationGroupName;
    @Column(name = "C_ENABLED")
    private boolean enabled = true;

    /*~ ----------------------------- constructors ------------------- */

    /** Dear JPA ... */
    protected RouteImpl() {
    }

    @ConstructorProperties("routeId")
    public RouteImpl(String routeId) {
        this.routeId = routeId;
    }

    /*~ ----------------------------- accessors ------------------- */

    @Override
    public void setPersistentKey(String pKey) {
        super.setPersistentKey(pKey);
    }

    @Override
    public String getRouteId() {
        return routeId;
    }

    public void setRouteId(String routeId) {
        this.routeId = routeId;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public boolean hasSourceLocation() {
        return sourceLocation != null;
    }

    public LocationEO getSourceLocation() {
        return sourceLocation;
    }

    public void setSourceLocation(LocationEO sourceLocation) {
        this.sourceLocation = sourceLocation;
    }

    public boolean hasTargetLocation() {
        return targetLocation != null;
    }

    public LocationEO getTargetLocation() {
        return targetLocation;
    }

    public void setTargetLocation(LocationEO targetLocation) {
        this.targetLocation = targetLocation;
    }

    public String getSourceLocationGroupName() {
        return sourceLocationGroupName;
    }

    public void setSourceLocationGroupName(String sourceLocationGroupName) {
        this.sourceLocationGroupName = sourceLocationGroupName;
    }

    public String getTargetLocationGroupName() {
        return targetLocationGroupName;
    }

    public void setTargetLocationGroupName(String targetLocationGroupName) {
        this.targetLocationGroupName = targetLocationGroupName;
    }

    public boolean isEnabled() {
        return enabled;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    /*~ ----------------------------- methods ------------------- */
    public static Route of(String routeId) {
        if (routeId == null || routeId.isEmpty())
            return DEF_ROUTE;
        return new RouteImpl(routeId);
    }

    @Override
    public String toString() {
        return routeId;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o)
            return true;
        if (o == null || (getClass() != o.getClass() && !o.getClass().equals(Route.class)))
            return false;
        Route route = (Route) o;
        return Objects.equals(routeId, route.getRouteId());
    }

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