/******************************************************************************
* Product: Adempiere ERP & CRM Smart Business Solution *
* Copyright (C) 1999-2006 ComPiere, Inc. All Rights Reserved. *
* This program is free software; you can redistribute it and/or modify it *
* under the terms version 2 of the GNU General Public License as published *
* by the Free Software Foundation. This program is distributed in the hope *
* that it will be useful, but WITHOUT ANY WARRANTY; without even the implied *
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. *
* See the GNU General Public License for more details. *
* You should have received a copy of the GNU General Public License along *
* with this program; if not, write to the Free Software Foundation, Inc., *
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *
* For the text or an alternative of this public license, you may reach us *
* ComPiere, Inc., 2620 Augustine Dr. #245, Santa Clara, CA 95054, USA *
* or via info@compiere.org or http://www.compiere.org/license.html *
*****************************************************************************/
package org.compiere.model;
import java.math.BigDecimal;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Calendar;
import java.util.GregorianCalendar;
import java.util.Properties;
import java.util.logging.Level;
import org.compiere.util.CLogger;
import org.compiere.util.DB;
import org.compiere.util.Env;
import org.compiere.util.Language;
import org.compiere.util.Msg;
import org.compiere.util.TimeUtil;
/**
* Resource Scheduling Utilities.
*
* @author Jorg Janke
* @version $Id: ScheduleUtil.java,v 1.2 2006/07/30 00:51:05 jjanke Exp $
*/
public class ScheduleUtil
{
/**
* Constructor
* @param ctx context
*/
public ScheduleUtil (Properties ctx)
{
m_ctx = ctx;
} // MSchedule
private Properties m_ctx;
private int m_S_Resource_ID;
private boolean m_isAvailable = true;
@SuppressWarnings("unused")
private boolean m_isSingleAssignment = true;
private int m_S_ResourceType_ID = 0;
private int m_C_UOM_ID = 0;
private Timestamp m_startDate = null;
private Timestamp m_endDate = null;
/** Resource Type Name */
private String m_typeName = null;
/** Resource Type Start Time */
private Timestamp m_slotStartTime = null;
/** Resource Type End Time */
private Timestamp m_slotEndTime = null;
/** Time Slots */
private MAssignmentSlot[] m_timeSlots = null;
/** Begin Timestamp 1/1/1970 */
public static final Timestamp EARLIEST = new Timestamp(new GregorianCalendar(1970,Calendar.JANUARY,1).getTimeInMillis());
/** End Timestamp 12/31/2070 */
public static final Timestamp LATEST = new Timestamp(new GregorianCalendar(2070,Calendar.DECEMBER,31).getTimeInMillis());
/** Logger */
private static CLogger log = CLogger.getCLogger(ScheduleUtil.class);
/**
* Get Assignments for time frame.
*
* - Resource is Active and Available
* - Resource UnAvailability
* - NonBusinessDay
* - ResourceType Available
*
* @param S_Resource_ID resource
* @param start_Date start date
* @param end_Date optional end date, need to provide qty to calculate it
* @param qty optional qty in ResourceType UOM. Ignored if end date is not null
* @param getAll if true return all errors
* @param trxName transaction
* @return Array of existing Assignments or null - if free
*/
public MAssignmentSlot[] getAssignmentSlots (int S_Resource_ID,
Timestamp start_Date, Timestamp end_Date,
BigDecimal qty, boolean getAll, String trxName)
{
if (log.isLoggable(Level.CONFIG)) log.config(start_Date.toString());
if (m_S_Resource_ID != S_Resource_ID)
getBaseInfo (S_Resource_ID);
//
ArrayList list = new ArrayList();
MAssignmentSlot ma = null;
if (!m_isAvailable)
{
ma = new MAssignmentSlot (EARLIEST, LATEST,
Msg.getMsg (m_ctx, "ResourceNotAvailable"), "", MAssignmentSlot.STATUS_NotAvailable);
if (!getAll)
return new MAssignmentSlot[] {ma};
list.add(ma);
}
m_startDate = start_Date;
m_endDate = end_Date;
if (m_endDate == null)
m_endDate = MUOMConversion.getEndDate(m_ctx, m_startDate, m_C_UOM_ID, qty);
if (log.isLoggable(Level.FINE)) log.fine( "- EndDate=" + m_endDate);
// Resource Unavailability -------------------------------------------
String sql = "SELECT Description, DateFrom, DateTo "
+ "FROM S_ResourceUnavailable "
+ "WHERE S_Resource_ID=?" // #1
+ " AND DateTo >= ?" // #2 start
+ " AND DateFrom <= ?" // #3 end
+ " AND IsActive='Y'";
PreparedStatement pstmt = null;
ResultSet rs = null;
try
{
pstmt = DB.prepareStatement(sql, trxName);
pstmt.setInt(1, m_S_Resource_ID);
pstmt.setTimestamp(2, m_startDate);
pstmt.setTimestamp(3, m_endDate);
rs = pstmt.executeQuery();
while (rs.next())
{
ma = new MAssignmentSlot (TimeUtil.getDay(rs.getTimestamp(2)),
TimeUtil.getNextDay(rs.getTimestamp(3)), // user entered date need to convert to not including end time
Msg.getMsg (m_ctx, "ResourceUnAvailable"), rs.getString(1),
MAssignmentSlot.STATUS_UnAvailable);
if (getAll)
createDaySlot (list, ma);
else
list.add(ma);
}
}
catch (SQLException e)
{
log.log(Level.SEVERE, sql, e);
ma = new MAssignmentSlot (EARLIEST, LATEST,
Msg.getMsg (m_ctx, "ResourceUnAvailable"), e.toString(),
MAssignmentSlot.STATUS_UnAvailable);
}
finally
{
DB.close(rs, pstmt);
rs = null;
pstmt = null;
}
if (ma != null && !getAll)
return new MAssignmentSlot[] {ma};
// NonBusinessDay ----------------------------------------------------
// "WHERE TRUNC(Date1) BETWEEN TRUNC(?) AND TRUNC(?)" causes
// ORA-00932: inconsistent datatypes: expected NUMBER got TIMESTAMP
sql = MRole.getDefault(m_ctx, false).addAccessSQL (
"SELECT Name, Date1 FROM C_NonBusinessDay "
+ "WHERE TRUNC(Date1) BETWEEN ? AND ? AND COALESCE(C_Country_ID,0) IN (0, ?)",
"C_NonBusinessDay", false, false); // not qualified - RO
try
{
Timestamp startDay = TimeUtil.getDay(m_startDate);
Timestamp endDay = TimeUtil.getDay(m_endDate);
pstmt = DB.prepareStatement(sql, trxName);
pstmt.setTimestamp(1, startDay);
pstmt.setTimestamp(2, endDay);
pstmt.setInt(3, Env.getContextAsInt(m_ctx, Env.C_COUNTRY_ID));
rs = pstmt.executeQuery();
while (rs.next())
{
Timestamp date = rs.getTimestamp(2);
ma = new MAssignmentSlot (TimeUtil.getDay(date),
TimeUtil.getNextDay(date), // user entered date need to convert to not including end time
Msg.getMsg(m_ctx, "NonBusinessDay"), rs.getString(1),
MAssignmentSlot.STATUS_NonBusinessDay);
if (log.isLoggable(Level.FINER)) log.finer("- NonBusinessDay " + ma);
list.add(ma);
}
}
catch (SQLException e)
{
log.log(Level.SEVERE, sql, e);
ma = new MAssignmentSlot (EARLIEST, LATEST,
Msg.getMsg(m_ctx, "NonBusinessDay"), e.toString(),
MAssignmentSlot.STATUS_NonBusinessDay);
}
finally
{
DB.close(rs, pstmt);
rs = null;
pstmt = null;
}
if (ma != null && !getAll)
return new MAssignmentSlot[] {ma};
// ResourceType Available --------------------------------------------
sql = "SELECT Name, IsTimeSlot,TimeSlotStart,TimeSlotEnd, " // 1..4
+ "IsDateSlot,OnMonday,OnTuesday,OnWednesday," // 5..8
+ "OnThursday,OnFriday,OnSaturday,OnSunday " // 9..12
+ "FROM S_ResourceType "
+ "WHERE S_ResourceType_ID=?";
try
{
pstmt = DB.prepareStatement(sql, trxName);
pstmt.setInt(1, m_S_ResourceType_ID);
rs = pstmt.executeQuery();
if (rs.next())
{
m_typeName = rs.getString(1);
// TimeSlot
if ("Y".equals(rs.getString(2)))
{
m_slotStartTime = TimeUtil.getDayTime (m_startDate, rs.getTimestamp(3));
m_slotEndTime = TimeUtil.getDayTime (m_endDate, rs.getTimestamp(4));
if (TimeUtil.inRange(m_startDate, m_endDate, m_slotStartTime, m_slotEndTime))
{
ma = new MAssignmentSlot (m_slotStartTime, m_slotEndTime,
Msg.getMsg(m_ctx, "ResourceNotInSlotTime"), m_typeName,
MAssignmentSlot.STATUS_NotInSlotTime);
if (getAll)
createTimeSlot (list,
rs.getTimestamp(3), rs.getTimestamp(4));
}
} // TimeSlot
// DaySlot
if ("Y".equals(rs.getString(5)))
{
if (TimeUtil.inRange(m_startDate, m_endDate,
"Y".equals(rs.getString(6)), "Y".equals(rs.getString(7)), // Mo..Tu
"Y".equals(rs.getString(8)), "Y".equals(rs.getString(9)), "Y".equals(rs.getString(10)), // We..Fr
"Y".equals(rs.getString(11)), "Y".equals(rs.getString(12))))
{
ma = new MAssignmentSlot (m_startDate, m_endDate,
Msg.getMsg(m_ctx, "ResourceNotInSlotDay"), m_typeName,
MAssignmentSlot.STATUS_NotInSlotDay);
if (getAll)
createDaySlot (list,
"Y".equals(rs.getString(6)), "Y".equals(rs.getString(7)), // Mo..Tu
"Y".equals(rs.getString(8)), "Y".equals(rs.getString(9)), "Y".equals(rs.getString(10)), // We..Fr
"Y".equals(rs.getString(11)), "Y".equals(rs.getString(12)));
}
} // DaySlot
}
}
catch (SQLException e)
{
log.log(Level.SEVERE, sql, e);
ma = new MAssignmentSlot (EARLIEST, LATEST,
Msg.getMsg(m_ctx, "ResourceNotInSlotDay"), e.toString(),
MAssignmentSlot.STATUS_NonBusinessDay);
}
finally
{
DB.close(rs, pstmt);
rs = null;
pstmt = null;
}
if (ma != null && !getAll)
return new MAssignmentSlot[] {ma};
// Assignments -------------------------------------------------------
sql = "SELECT S_ResourceAssignment_ID "
+ "FROM S_ResourceAssignment "
+ "WHERE S_Resource_ID=?" // #1
+ " AND AssignDateTo >= ?" // #2 start
+ " AND AssignDateFrom <= ?" // #3 end
+ " AND IsActive='Y'";
try
{
pstmt = DB.prepareStatement(sql, trxName);
pstmt.setInt(1, m_S_Resource_ID);
pstmt.setTimestamp(2, m_startDate);
pstmt.setTimestamp(3, m_endDate);
rs = pstmt.executeQuery();
while (rs.next())
{
MResourceAssignment mAssignment =
new MResourceAssignment(Env.getCtx(), rs.getInt(1), trxName);
ma = new MAssignmentSlot (mAssignment);
if (!getAll)
break;
list.add(ma);
}
}
catch (SQLException e)
{
log.log(Level.SEVERE, sql, e);
ma = new MAssignmentSlot (EARLIEST, LATEST,
Msg.translate(m_ctx, "S_R"), e.toString(),
MAssignmentSlot.STATUS_NotConfirmed);
}
finally
{
DB.close(rs, pstmt);
rs = null;
pstmt = null;
}
if (ma != null && !getAll)
return new MAssignmentSlot[] {ma};
// fill m_timeSlots (required for layout)
createTimeSlots();
// Clean list - date range
ArrayList clean = new ArrayList(list.size());
for (int i = 0; i < list.size(); i++)
{
MAssignmentSlot mas = (MAssignmentSlot)list.get(i);
if ((mas.getStartTime().equals(m_startDate) || mas.getStartTime().after(m_startDate))
&& (mas.getEndTime().equals(m_endDate) || mas.getEndTime().before(m_endDate)))
clean.add(mas);
}
// Delete Unavailability TimeSlots when all day assignments exist
MAssignmentSlot[] sorted = new MAssignmentSlot[clean.size()];
clean.toArray(sorted);
Arrays.sort(sorted, new MAssignmentSlot()); // sorted by start/end date
list.clear(); // used as day list
clean.clear(); // cleaned days
Timestamp sortedDay = null;
for (int i = 0; i < sorted.length; i++)
{
if (sortedDay == null)
sortedDay = TimeUtil.getDay(sorted[i].getStartTime());
if (sortedDay.equals(TimeUtil.getDay(sorted[i].getStartTime())))
list.add(sorted[i]);
else
{
// process info list -> clean
layoutSlots (list, clean);
// prepare next
list.clear();
list.add(sorted[i]);
sortedDay = TimeUtil.getDay(sorted[i].getStartTime());
}
}
// process info list -> clean
layoutSlots (list, clean);
// Return
MAssignmentSlot[] retValue = new MAssignmentSlot[clean.size()];
clean.toArray(retValue);
Arrays.sort(retValue, new MAssignmentSlot()); // sorted by start/end date
return retValue;
} // getAssignmentSlots
/**
* Copy valid Slots of a day from list to clear and layout
* @param list list with slots of the day
* @param clean list with only valid slots
*/
@SuppressWarnings("unchecked")
private void layoutSlots (ArrayList list, ArrayList clean)
{
int size = list.size();
if (size == 0)
return;
else if (size == 1)
{
MAssignmentSlot mas = (MAssignmentSlot)list.get(0);
layoutY (mas);
clean.add (mas);
return;
}
// Delete Unavailability TimeSlots when all day assignments exist
boolean allDay = false;
for (int i = 0; !allDay && i < size; i++)
{
MAssignmentSlot mas = (MAssignmentSlot)list.get(i);
if (mas.getStatus() == MAssignmentSlot.STATUS_NotAvailable
|| mas.getStatus() == MAssignmentSlot.STATUS_UnAvailable
|| mas.getStatus() == MAssignmentSlot.STATUS_NonBusinessDay
|| mas.getStatus() == MAssignmentSlot.STATUS_NotInSlotDay)
allDay = true;
}
if (allDay)
{
// delete Time Slot
for (int i = 0; i < list.size(); i++)
{
MAssignmentSlot mas = (MAssignmentSlot)list.get(i);
if (mas.getStatus() == MAssignmentSlot.STATUS_NotInSlotTime)
list.remove(i--);
}
}
// Copy & Y layout remaining
for (int i = 0; i < list.size(); i++)
{
MAssignmentSlot mas = (MAssignmentSlot)list.get(i);
layoutY (mas);
clean.add (mas);
}
// X layout
int maxYslots = m_timeSlots.length;
int[] xSlots = new int[maxYslots]; // number of parallel slots
for (int i = 0; i < list.size(); i++)
{
MAssignmentSlot mas = (MAssignmentSlot)list.get(i);
for (int y = mas.getYStart(); y < mas.getYEnd(); y++)
xSlots[y]++;
}
// Max parallel X Slots
int maxXslots = 0;
for (int y = 0; y < xSlots.length; y++)
{
if (xSlots[y] > maxXslots)
maxXslots = xSlots[y];
}
// Only one column
if (maxXslots < 2)
{
for (int i = 0; i < list.size(); i++)
{
MAssignmentSlot mas = (MAssignmentSlot)list.get(i);
mas.setX(0, 1);
}
return;
}
// Create xy Matrix
ArrayList