net.sf.mpxj.mspdi

Class MSPDIWriter

java.lang.Object

net.sf.mpxj.writer.AbstractProjectWriter

net.sf.mpxj.mspdi.MSPDIWriter

All Implemented Interfaces:

ProjectWriter

public final class MSPDIWriter
extends AbstractProjectWriter

This class creates a new MSPDI file from the contents of an ProjectFile instance.

Constructor Summary

Constructors

Constructor and Description
MSPDIWriter()

Method Summary

Modifier and Type	Method and Description
boolean	getGenerateMissingTimephasedData() Returns true if the experimental feature to generate timephased data for tasks with no timephased data present is enabled.
boolean	getMicrosoftProjectCompatibleOutput() Retrieves a flag which determines if the output is readable by MS Project.
SaveVersion	getSaveVersion() Retrieve the save version current set.
boolean	getSplitTimephasedAsDays() Retrieves a flag to control whether timephased assignment data is split into days.
boolean	getWriteTimephasedData() Retrieves the state of the flag which controls whether timephased resource assignment data is written to the file.
void	setGenerateMissingTimephasedData(boolean value) Pass true to this method to enable an experimental feature where timephased data is generated for tasks with no timephased data present.
void	setMicrosoftProjectCompatibleOutput(boolean flag) Sets a flag to determine if the output is readable by MS Project, or is "spec compliant".
void	setSaveVersion(SaveVersion version) Set the save version to use when generating an MSPDI file.
void	setSplitTimephasedAsDays(boolean flag) Sets a flag to control whether timephased assignment data is split into days.
void	setWriteTimephasedData(boolean value) Sets a flag to control whether timephased resource assignment data is written to the file.
void	write(ProjectFile projectFile, OutputStream stream) Write a project file's content to the supplied OutputStream instance.

Methods inherited from class net.sf.mpxj.writer.AbstractProjectWriter

write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MSPDIWriter

public MSPDIWriter()

Method Detail

setMicrosoftProjectCompatibleOutput

public void setMicrosoftProjectCompatibleOutput(boolean flag)

Sets a flag to determine if the output is readable by MS Project, or is "spec compliant".

Parameters:

flag - true if output is readable by MS Project

getMicrosoftProjectCompatibleOutput

public boolean getMicrosoftProjectCompatibleOutput()

Retrieves a flag which determines if the output is readable by MS Project.

Returns:

true if output is readable by MS Project

setSplitTimephasedAsDays

public void setSplitTimephasedAsDays(boolean flag)

Sets a flag to control whether timephased assignment data is split into days. The default is true.

Parameters:

flag - boolean flag

getSplitTimephasedAsDays

public boolean getSplitTimephasedAsDays()

Retrieves a flag to control whether timephased assignment data is split into days. The default is true.

Returns:

boolean true

setWriteTimephasedData

public void setWriteTimephasedData(boolean value)

Sets a flag to control whether timephased resource assignment data is written to the file. The default is false.

Parameters:

value - boolean flag

getWriteTimephasedData

public boolean getWriteTimephasedData()

Retrieves the state of the flag which controls whether timephased resource assignment data is written to the file. The default is false.

Returns:

boolean flag

setGenerateMissingTimephasedData

public void setGenerateMissingTimephasedData(boolean value)

Pass true to this method to enable an experimental feature where timephased data is generated for tasks with no timephased data present. NOTE: this feature is disabled by default.

Parameters:

value - true to enable timephased data generation

getGenerateMissingTimephasedData

public boolean getGenerateMissingTimephasedData()

Returns true if the experimental feature to generate timephased data for tasks with no timephased data present is enabled. NOTE: this feature is disabled by default.

Returns:

true if feature enabled

setSaveVersion

public void setSaveVersion(SaveVersion version)

Set the save version to use when generating an MSPDI file.

Parameters:

version - save version

getSaveVersion

public SaveVersion getSaveVersion()

Retrieve the save version current set.

Returns:

current save version

write

public void write(ProjectFile projectFile,
                  OutputStream stream)
           throws IOException

Description copied from interface: ProjectWriter

Write a project file's content to the supplied OutputStream instance.

Parameters:

projectFile - project file instance

stream - OutputStream instance

Throws:

IOException