net.sf.mpxj.primavera.PrimaveraPMFileWriter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mpxj Show documentation
Show all versions of mpxj Show documentation
Library that provides facilities to allow project information to be manipulated in Java and .Net. Supports a range of data formats: Microsoft Project Exchange (MPX), Microsoft Project (MPP,MPT), Microsoft Project Data Interchange (MSPDI XML), Microsoft Project Database (MPD), Planner (XML), Primavera (PM XML, XER, and database), Asta Powerproject (PP, MDB), Asta Easyplan (PP), Phoenix Project Manager (PPX), FastTrack Schedule (FTS), and the Standard Data Exchange Format (SDEF).
/*
* file: PrimaveraPMFileWriter.java
* author: Jon Iles
* copyright: (c) Packwood Software 2012
* date: 2012-03-16
*/
/*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by the
* Free Software Foundation; either version 2.1 of the License, or (at your
* option) any later version.
*
* This library 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 Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
*/
package net.sf.mpxj.primavera;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Date;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.sax.TransformerHandler;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import net.sf.mpxj.ConstraintType;
import net.sf.mpxj.CustomField;
import net.sf.mpxj.CustomFieldContainer;
import net.sf.mpxj.DateRange;
import net.sf.mpxj.Day;
import net.sf.mpxj.Duration;
import net.sf.mpxj.FieldContainer;
import net.sf.mpxj.FieldType;
import net.sf.mpxj.FieldTypeClass;
import net.sf.mpxj.ProjectCalendar;
import net.sf.mpxj.ProjectCalendarException;
import net.sf.mpxj.ProjectFile;
import net.sf.mpxj.ProjectProperties;
import net.sf.mpxj.Relation;
import net.sf.mpxj.RelationType;
import net.sf.mpxj.Resource;
import net.sf.mpxj.ResourceAssignment;
import net.sf.mpxj.Task;
import net.sf.mpxj.TaskField;
import net.sf.mpxj.TimeUnit;
import net.sf.mpxj.common.FieldTypeHelper;
import net.sf.mpxj.common.NumberHelper;
import net.sf.mpxj.primavera.schema.APIBusinessObjects;
import net.sf.mpxj.primavera.schema.ActivityType;
import net.sf.mpxj.primavera.schema.CalendarType;
import net.sf.mpxj.primavera.schema.CalendarType.HolidayOrExceptions;
import net.sf.mpxj.primavera.schema.CalendarType.HolidayOrExceptions.HolidayOrException;
import net.sf.mpxj.primavera.schema.CalendarType.StandardWorkWeek;
import net.sf.mpxj.primavera.schema.CalendarType.StandardWorkWeek.StandardWorkHours;
import net.sf.mpxj.primavera.schema.ObjectFactory;
import net.sf.mpxj.primavera.schema.ProjectType;
import net.sf.mpxj.primavera.schema.RelationshipType;
import net.sf.mpxj.primavera.schema.ResourceAssignmentType;
import net.sf.mpxj.primavera.schema.ResourceType;
import net.sf.mpxj.primavera.schema.UDFAssignmentType;
import net.sf.mpxj.primavera.schema.UDFTypeType;
import net.sf.mpxj.primavera.schema.WBSType;
import net.sf.mpxj.primavera.schema.WorkTimeType;
import net.sf.mpxj.writer.AbstractProjectWriter;
/**
* This class creates a new MSPDI file from the contents of an ProjectFile
* instance.
*/
public final class PrimaveraPMFileWriter extends AbstractProjectWriter
{
/**
* Set the task field which will be used to populate the Activity ID attribute
* in the PMXML file. Currently this defaults to TaskField.WBS. If you are
* reading in a project from Primavera, typically the original Activity ID will
* be in the Text1 field, so calling this method with TaskField.TEXT1 will write
* the original Activity ID values in the PMXML file.
*
* @param field TaskField instance
*/
public void setActivityIdField(TaskField field)
{
m_activityIDField = field;
}
/**
* Retrieve the task field which will be used to populate the Activity ID attribute
* in the PMXML file.
*
* @return TaskField instance
*/
public TaskField getActivityIdField()
{
return m_activityIDField;
}
/**
* {@inheritDoc}
*/
@Override public void write(ProjectFile projectFile, OutputStream stream) throws IOException
{
try
{
if (CONTEXT == null)
{
throw CONTEXT_EXCEPTION;
}
//
// The Primavera schema defines elements as nillable, which by
// default results in
// JAXB generating elements like this relations = task.getPredecessors();
for (Relation mpxj : relations)
{
RelationshipType xml = m_factory.createRelationshipType();
m_project.getRelationship().add(xml);
xml.setLag(getDuration(mpxj.getLag()));
xml.setObjectId(Integer.valueOf(++m_relationshipObjectID));
xml.setPredecessorActivityObjectId(mpxj.getTargetTask().getUniqueID());
xml.setSuccessorActivityObjectId(mpxj.getSourceTask().getUniqueID());
xml.setPredecessorProjectObjectId(PROJECT_OBJECT_ID);
xml.setSuccessorProjectObjectId(PROJECT_OBJECT_ID);
xml.setType(RELATION_TYPE_MAP.get(mpxj.getType()));
}
}
/**
* Writes a list of IDF types.
*
* @author lsong
* @param type parent entity type
* @param mpxj parent entity
* @return list of UDFAssignmentType instances
*/
private List writeUDFType(FieldTypeClass type, FieldContainer mpxj)
{
CustomFieldContainer customFields = m_projectFile.getCustomFields();
List out = new ArrayList(customFields.size());
for (CustomField cf : customFields)
{
FieldType fieldType = cf.getFieldType();
if (type == fieldType.getFieldTypeClass())
{
UDFAssignmentType udf = m_factory.createUDFAssignmentType();
udf.setTypeObjectId(FieldTypeHelper.getFieldID(fieldType));
UDFAssignmentType.setUserFieldValue(udf, fieldType.getDataType(), mpxj.getCachedValue(fieldType));
out.add(udf);
}
}
return out;
}
/**
* Retrieve a duration in the form required by Primavera.
*
* @param duration Duration instance
* @return formatted duration
*/
private Double getDuration(Duration duration)
{
Double result;
if (duration == null)
{
result = null;
}
else
{
if (duration.getUnits() != TimeUnit.HOURS)
{
duration = duration.convertUnits(TimeUnit.HOURS, m_projectFile.getProjectProperties());
}
result = Double.valueOf(duration.getDuration());
}
return result;
}
/**
* Formats a day name.
*
* @param day MPXJ Day instance
* @return Primavera day instance
*/
private String getDayName(Day day)
{
return DAY_NAMES[day.getValue() - 1];
}
/**
* Formats a resource type.
*
* @param resource MPXJ resource
* @return Primavera resource type
*/
private String getResourceType(Resource resource)
{
String result;
switch (resource.getType())
{
case MATERIAL:
{
result = "Material";
break;
}
case COST:
{
result = "Nonlabor";
break;
}
default:
{
result = "Labor";
break;
}
}
return result;
}
/**
* Formats a percentage value.
*
* @param number MPXJ percentage value
* @return Primavera percentage value
*/
private Double getPercentage(Number number)
{
Double result = null;
if (number != null)
{
result = Double.valueOf(number.doubleValue() / 100);
}
return result;
}
/**
* Formats a double value.
*
* @param number numeric value
* @return Double instance
*/
private Double getDouble(Number number)
{
Double result = null;
if (number != null)
{
result = Double.valueOf(number.doubleValue());
}
return result;
}
/**
* The end of a Primavera time range finishes on the last minute
* of the period, so a range of 12:00 -> 13:00 is represented by
* Primavera as 12:00 -> 12:59.
*
* @param date MPXJ end time
* @return Primavera end time
*/
private Date getEndTime(Date date)
{
return new Date(date.getTime() - 60000);
}
/**
* Retrieve a calendar unique ID.
*
* @param calendar ProjectCalendar instance
* @return calendar unique ID
*/
private Integer getCalendarUniqueID(ProjectCalendar calendar)
{
return calendar == null ? null : calendar.getUniqueID();
}
/**
* Retrieve an activity status.
*
* @param mpxj MPXJ Task instance
* @return activity status
*/
private String getActivityStatus(Task mpxj)
{
String result;
if (mpxj.getActualStart() == null)
{
result = "Not Started";
}
else
{
if (mpxj.getActualFinish() == null)
{
result = "In Progress";
}
else
{
result = "Completed";
}
}
return result;
}
/**
* Retrieve the Activity ID value for this task.
* @param task Task instance
* @return Activity ID value
*/
private String getActivityID(Task task)
{
String result = null;
if (m_activityIDField != null)
{
Object value = task.getCachedValue(m_activityIDField);
if (value != null)
{
result = value.toString();
}
}
return result;
}
/**
* Package-private accessor method used to retrieve the project file
* currently being processed by this writer.
*
* @return project file instance
*/
ProjectFile getProjectFile()
{
return (m_projectFile);
}
/**
* Cached context to minimise construction cost.
*/
private static JAXBContext CONTEXT;
/**
* Note any error occurring during context construction.
*/
private static JAXBException CONTEXT_EXCEPTION;
static
{
try
{
//
// JAXB RI property to speed up construction
//
System.setProperty("com.sun.xml.bind.v2.runtime.JAXBContextImpl.fastBoot", "true");
//
// Construct the context
//
CONTEXT = JAXBContext.newInstance("net.sf.mpxj.primavera.schema", PrimaveraPMFileWriter.class.getClassLoader());
}
catch (JAXBException ex)
{
CONTEXT_EXCEPTION = ex;
CONTEXT = null;
}
}
private static final String NILLABLE_STYLESHEET = " RELATION_TYPE_MAP = new HashMap();
static
{
RELATION_TYPE_MAP.put(RelationType.FINISH_START, "Finish to Start");
RELATION_TYPE_MAP.put(RelationType.FINISH_FINISH, "Finish to Finish");
RELATION_TYPE_MAP.put(RelationType.START_START, "Start to Start");
RELATION_TYPE_MAP.put(RelationType.START_FINISH, "Start to Finish");
}
private static final Map CONSTRAINT_TYPE_MAP = new HashMap();
static
{
CONSTRAINT_TYPE_MAP.put(ConstraintType.START_NO_LATER_THAN, "Start On or Before");
CONSTRAINT_TYPE_MAP.put(ConstraintType.START_NO_EARLIER_THAN, "Start On or After");
CONSTRAINT_TYPE_MAP.put(ConstraintType.MUST_FINISH_ON, "Finish On");
CONSTRAINT_TYPE_MAP.put(ConstraintType.FINISH_NO_LATER_THAN, "Finish On or Before");
CONSTRAINT_TYPE_MAP.put(ConstraintType.FINISH_NO_EARLIER_THAN, "Finish On or After");
CONSTRAINT_TYPE_MAP.put(ConstraintType.AS_LATE_AS_POSSIBLE, "As Late As Possible");
CONSTRAINT_TYPE_MAP.put(ConstraintType.MUST_START_ON, "Mandatory Start");
CONSTRAINT_TYPE_MAP.put(ConstraintType.MUST_FINISH_ON, "Mandatory Finish");
}
private ProjectFile m_projectFile;
private ObjectFactory m_factory;
private APIBusinessObjects m_apibo;
private ProjectType m_project;
private int m_wbsSequence;
private int m_relationshipObjectID;
private Calendar m_calendar;
private TaskField m_activityIDField = TaskField.WBS;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy