org.optaplanner.examples.nurserostering.domain.NurseRoster Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of optaplanner-examples Show documentation
OptaPlanner solves planning problems. This lightweight, embeddable planning engine implements powerful and scalable algorithms to optimize business resource scheduling and planning. This module contains the examples which demonstrate how to use it in a normal Java application.
There is a newer version: 9.44.0.Final
Show newest version
/*
 * Copyright 2010 Red Hat, Inc. and/or its affiliates.
 *
 * 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.optaplanner.examples.nurserostering.domain;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamConverter;
import org.optaplanner.core.api.domain.solution.PlanningEntityCollectionProperty;
import org.optaplanner.core.api.domain.solution.PlanningSolution;
import org.optaplanner.core.api.domain.solution.Solution;
import org.optaplanner.core.api.domain.valuerange.ValueRangeProvider;
import org.optaplanner.core.api.score.buildin.hardsoft.HardSoftScore;
import org.optaplanner.core.impl.score.buildin.hardsoft.HardSoftScoreDefinition;
import org.optaplanner.examples.common.domain.AbstractPersistable;
import org.optaplanner.examples.nurserostering.domain.contract.Contract;
import org.optaplanner.examples.nurserostering.domain.contract.ContractLine;
import org.optaplanner.examples.nurserostering.domain.contract.PatternContractLine;
import org.optaplanner.examples.nurserostering.domain.pattern.Pattern;
import org.optaplanner.examples.nurserostering.domain.request.DayOffRequest;
import org.optaplanner.examples.nurserostering.domain.request.DayOnRequest;
import org.optaplanner.examples.nurserostering.domain.request.ShiftOffRequest;
import org.optaplanner.examples.nurserostering.domain.request.ShiftOnRequest;
import org.optaplanner.persistence.xstream.impl.score.XStreamScoreConverter;

@PlanningSolution
@XStreamAlias("NurseRoster")
public class NurseRoster extends AbstractPersistable implements Solution {

    private String code;

    private NurseRosterParametrization nurseRosterParametrization;
    private List skillList;
    private List shiftTypeList;
    private List shiftTypeSkillRequirementList;
    private List patternList;
    private List contractList;
    private List contractLineList;
    private List patternContractLineList;
    private List employeeList;
    private List skillProficiencyList;
    private List shiftDateList;
    private List shiftList;
    private List dayOffRequestList;
    private List dayOnRequestList;
    private List shiftOffRequestList;
    private List shiftOnRequestList;

    private List shiftAssignmentList;

    @XStreamConverter(value = XStreamScoreConverter.class, types = {HardSoftScoreDefinition.class})
    private HardSoftScore score;

    public String getCode() {
        return code;
    }

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

    public NurseRosterParametrization getNurseRosterParametrization() {
        return nurseRosterParametrization;
    }

    public void setNurseRosterParametrization(NurseRosterParametrization nurseRosterParametrization) {
        this.nurseRosterParametrization = nurseRosterParametrization;
    }

    public List getSkillList() {
        return skillList;
    }

    public void setSkillList(List skillList) {
        this.skillList = skillList;
    }

    public List getShiftTypeList() {
        return shiftTypeList;
    }

    public void setShiftTypeList(List shiftTypeList) {
        this.shiftTypeList = shiftTypeList;
    }

    public List getShiftTypeSkillRequirementList() {
        return shiftTypeSkillRequirementList;
    }

    public void setShiftTypeSkillRequirementList(List shiftTypeSkillRequirementList) {
        this.shiftTypeSkillRequirementList = shiftTypeSkillRequirementList;
    }

    public List getPatternList() {
        return patternList;
    }

    public void setPatternList(List patternList) {
        this.patternList = patternList;
    }

    public List getContractList() {
        return contractList;
    }

    public void setContractList(List contractList) {
        this.contractList = contractList;
    }

    public List getContractLineList() {
        return contractLineList;
    }

    public void setContractLineList(List contractLineList) {
        this.contractLineList = contractLineList;
    }

    public List getPatternContractLineList() {
        return patternContractLineList;
    }

    public void setPatternContractLineList(List patternContractLineList) {
        this.patternContractLineList = patternContractLineList;
    }

    @ValueRangeProvider(id = "employeeRange")
    public List getEmployeeList() {
        return employeeList;
    }

    public void setEmployeeList(List employeeList) {
        this.employeeList = employeeList;
    }

    public List getSkillProficiencyList() {
        return skillProficiencyList;
    }

    public void setSkillProficiencyList(List skillProficiencyList) {
        this.skillProficiencyList = skillProficiencyList;
    }

    public List getShiftDateList() {
        return shiftDateList;
    }

    public void setShiftDateList(List shiftDateList) {
        this.shiftDateList = shiftDateList;
    }

    public List getShiftList() {
        return shiftList;
    }

    public void setShiftList(List shiftList) {
        this.shiftList = shiftList;
    }

    public List getDayOffRequestList() {
        return dayOffRequestList;
    }

    public void setDayOffRequestList(List dayOffRequestList) {
        this.dayOffRequestList = dayOffRequestList;
    }

    public List getDayOnRequestList() {
        return dayOnRequestList;
    }

    public void setDayOnRequestList(List dayOnRequestList) {
        this.dayOnRequestList = dayOnRequestList;
    }

    public List getShiftOffRequestList() {
        return shiftOffRequestList;
    }

    public void setShiftOffRequestList(List shiftOffRequestList) {
        this.shiftOffRequestList = shiftOffRequestList;
    }

    public List getShiftOnRequestList() {
        return shiftOnRequestList;
    }

    public void setShiftOnRequestList(List shiftOnRequestList) {
        this.shiftOnRequestList = shiftOnRequestList;
    }

    @PlanningEntityCollectionProperty
    public List getShiftAssignmentList() {
        return shiftAssignmentList;
    }

    public void setShiftAssignmentList(List shiftAssignmentList) {
        this.shiftAssignmentList = shiftAssignmentList;
    }

    public HardSoftScore getScore() {
        return score;
    }

    public void setScore(HardSoftScore score) {
        this.score = score;
    }

    // ************************************************************************
    // Complex methods
    // ************************************************************************

    public Collection getProblemFacts() {
        List