Graphic Reporting - Administration Guide : Gantt Chart

<ColorSchema>
    <Task>rgb(0,0,1)</Task>
    <TaskProgress>rgb(0,0,2)</TaskProgress>
    <TaskLabel>rgb(0,0,3)</TaskLabel>
    <TaskBaseline>rgb(0,0,4)</TaskBaseline>
    <TaskSlipDays>rgb(0,0,5)</TaskSlipDays>
    <Project>rgb(0,0,6)</Project>
    <ProjectBaseline>rgb(0,0,7)</ProjectBaseline>
    <ProjectSlipDays>rgb(0,0,8)</ProjectSlipDays>
    <Phase>rgb(0,0,9)</Phase>
    <PhaseLabel>rgb(0,0,10)</PhaseLabel>
    <PhaseBaseline>rgb(0,0,11)</PhaseBaseline>
    <PhaseSlipDays>rgb(0,0,12)</PhaseSlipDays>
    <Milestone>rgb(0,0,13)</Milestone>
    <MilestoneLabel>rgb(0,0,14)</MilestoneLabel>
    <MilestoneBaseline>rgb(0,0,15)</MilestoneBaseline>
    <MilestoneSlipDays>rgb(0,0,16)</MilestoneSlipDays>
    <CriticalPath>rgb(0,0,17)</CriticalPath>
    <CriticalPathLabel>rgb(0,0,18)</CriticalPathLabel>
    <Timeline1>rgb(0,0,19)</Timeline1>
    <Timeline2>rgb(0,0,20)</Timeline2>
    <Timeline3>rgb(0,0,21)</Timeline3>
    <Timeline4>rgb(0,0,22)</Timeline4>
    <CalendarCurrentDate>(0,0,23)</CalendarCurrentDate>
</ColorSchema>

<FontSchema>
    <Task>arial,bold,12</Task>
    <Project>courier,plain,10</Project>
    <Phase>verdana,bold,12</Phase>
    <Milestone>arial,bold+italic,20</Milestone>
    <Timeline1>tahoma,plain,20</Timeline1>
    <Timeline2>tahoma,bold,14</Timeline2>
    <Timeline3>tahoma,italic,12</Timeline3>
    <Timeline4>tahoma,italic+bold,10</Timeline4>
</FontSchema>

<GraphHandlerClass>com.technia.example.MyGanttChartHandler</GraphHandlerClass>

public class MyGanttHandler implements GanttChartHandler {

    private void applyColor(GanttChartNode node, NodeGraph graph) {
        String current = node.getObjectData().getSelectData(Statement.CURRENT.getStatement());
        if ("Create".equals(current) || "Assign".equals(current)) {
            graph.setColor(Color.LIGHT_GRAY);
            graph.setLabelColor(Color.LIGHT_GRAY);
        } else if ("Active".equals(current)) {
            graph.setColor(Color.GRAY);
            graph.setLabelColor(Color.GRAY);
        } else if ("Complete".equals(current) || "Review".equals(current)) {
            graph.setColor(Color.GREEN);
        } else {
            graph.setColor(Color.BLACK);
            graph.setLabelColor(Color.BLACK);
        }
    }

    @Override
    public void populateMilestones(GanttChartNode node, MilestoneGraph graph) {
        graph.setColor(Color.RED);
    }

    @Override
    public void populatePhases(GanttChartNode node, PhaseGraph graph) {
        // applyColor(node, graph);
    }

    @Override
    public void populateProject(GanttChartNode node, ProjectGraph graph) {
        // applyColor(node, graph);
    }

    @Override
    public void populateTasks(GanttChartNode node, TaskGraph graph) {
        applyColor(node, graph);
    }

    @Override
    public void prepareEvaluation(Input input) {
        input.addObjectSelect(Statement.CURRENT.getStatement());
    }
}

<!-- The "gantt-chart" element is the document
     element. It contains zero or more "graph"
     elements. -->
<!ELEMENT gantt-chart (graph*)>

<!-- The "graph" element defines a graph on the
Gantt chart. There are four types of graphs,
i.e., task, phase, milestone and project.

type Defines the type of the graph.
Accepted values are task, phase,
milestone and project.

object-id The ID of the business object
that the graph represents.

id The ID of the actual graph. The
ID of the graph is used when
resolving graph dependencies.
The id attribute can be left out
when not applicable (e.g., when
no dependencies are used).

NB! Two graphs should NOT have the
same ID or otherwise the dependencies
might not be resolved correctly.

Used in: gantt-chart
-->
<!ELEMENT graph (name, estimated-start, estimated-finish, actual-start?,
actual-finish?, baseline-initial-start?, baseline-initial-end?,
baseline-current-start?,
baseline-current-end?, tooltip?, percent-complete?, graph*,
dependency*)>
<!ATTLIST graph
type (phase|task|milestone|project) #REQUIRED
object-id CDATA #IMPLIED
id ID #IMPLIED
>


<!-- The "name" element defines the name of a graph.

Used in: graph
-->
<!ELEMENT name (#PCDATA)>


<!-- The "estimated-start" element defines the estimated
start date of a graph. Its value should comply with
the same format as date values inside the ENOVIA
database, or to the explicit format specified in the
format attribute when used.

format The date format used within the body
of the element. The date format will
default to the one used inside the
ENOVIA database when this attribute
is not defined.

Used in: graph
-->
<!ELEMENT estimated-start (#PCDATA)>
<!ATTLIST estimated-start
format CDATA #IMPLIED
>


<!-- The "estimated-finish" element defines the estimated
finish date of a graph. Its value should comply with
the same format as date values inside the ENOVIA
database, or to the explicit format specified in the
format attribute when used.

format The date format used within the body
of the element. The date format will
default to the one used inside the
ENOVIA database when this attribute
is not defined.

Used in: graph
-->
<!ELEMENT estimated-finish (#PCDATA)>
<!ATTLIST estimated-finish
format CDATA #IMPLIED
>


<!-- The "actual-start" element defines the actual
start date of a graph. Its value should comply with

the same format as date values inside the ENOVIA
database, or to the explicit format specified in the
format attribute when used.

format The date format used within the body
of the element. The date format will
default to the one used inside the
ENOVIA database when this attribute
is not defined.

Used in: graph
-->
<!ELEMENT actual-start (#PCDATA)>
<!ATTLIST actual-start
format CDATA #IMPLIED
>


<!-- The "actual-finish" element defines the actual
finish date of a graph. Its value should comply with
the same format as date values inside the ENOVIA
database, or to the explicit format specified in the
format attribute when used.

format The date format used within the body
of the element. The date format will
default to the one used inside the
ENOVIA database when this attribute
is not defined.

Used in: graph
-->
<!ELEMENT actual-finish (#PCDATA)>
<!ATTLIST actual-finish
format CDATA #IMPLIED
>


<!-- The "baseline-initial-start" element defines the initial
baseline start date of a graph. Its value should comply with
the same format as date values inside the ENOVIA
database, or to the explicit format specified in the
format attribute when used.

format The date format used within the body
of the element. The date format will
default to the one used inside the
ENOVIA database when this attribute
is not defined.

Used in: graph
-->
<!ELEMENT baseline-initial-start (#PCDATA)>
<!ATTLIST baseline-initial-start
format CDATA #IMPLIED
>


<!-- The "baseline-initial-start" element defines the initial
baseline end date of a graph. Its value should comply with
the same format as date values inside the ENOVIA
database, or to the explicit format specified in the
format attribute when used.

format The date format used within the body
of the element. The date format will
default to the one used inside the
ENOVIA database when this attribute
is not defined.

Used in: graph
-->
<!ELEMENT baseline-initial-end (#PCDATA)>
<!ATTLIST baseline-initial-end
format CDATA #IMPLIED
>


<!-- The "baseline-current-start" element defines the current
baseline start date of a graph. Its value should comply with
the same format as date values inside the ENOVIA
database, or to the explicit format specified in the
format attribute when used.

format The date format used within the body
of the element. The date format will
default to the one used inside the
ENOVIA database when this attribute
is not defined.

Used in: graph
-->
<!ELEMENT baseline-current-start (#PCDATA)>
<!ATTLIST baseline-current-start
format CDATA #IMPLIED
>


<!-- The "baseline-current-end" element defines the current
baseline end date of a graph. Its value should comply with
the same format as date values inside the ENOVIA
database, or to the explicit format specified in the
format attribute when used.

format The date format used within the body
of the element. The date format will
default to the one used inside the
ENOVIA database when this attribute
is not defined.

Used in: graph
-->
<!ELEMENT baseline-current-end (#PCDATA)>
<!ATTLIST baseline-current-end
format CDATA #IMPLIED
>


<!-- The "tooltip" element defines the tooltip that will be
displayed when the mouse pointer hoover above the graph
or the graphs label.

Used in: graph
-->
<!ELEMENT tooltip (#PCDATA)>

<!-- The "percent-complete" element defines how many
percent of the graph have been completed. Its value
should be an integer between 0 and 100 inclusive.

Used in: graph
-->
<!ELEMENT percent-complete (#PCDATA)>


<!-- The "dependency" element defines a dependency for a graph.

type The type of dependency. Accepted
values are SS, SF, FS and FF. These

acronyms expand to Start-to-Start,
Start-to-Finish, Finish-to-Start
and Finish-to-Finish.

id-ref The ID of the graph that the current
graph depend on. E.g., if graph A
depends on graph B, graph A should
have a "dependency" element whose
id-ref attribute contains the ID of
graph B.

Used in: graph
-->
<!ELEMENT dependency EMPTY>
<!ATTLIST dependency
type (SS|SF|FS|FF) #REQUIRED
id-ref IDREF #REQUIRED
>

/*
 * JPO Gantt Chart Generator Template
 */
import matrix.db.*;
import java.util.*;

/**
 * This is a simple template that you can use
 * when creating a JPO that generate Gantt charts.
 * If you want more tips and tricks you can also
 * check the program TVCGanttChartUtils that is
 * installed with the database schema for the
 * TVC Graphic Reporting component.
 */
public class ${CLASSNAME} {

    /**
     * Implement this method to return the XML
     * that defines the Gantt chart.
     */
    public String generate(Context ctx,
                           String[] args)
                    throws Exception{

        // Unpack the arguments
        Map params = (Map) JPO.unpackArgs(args);

        // Get the ID of the root business object
        String objectId = (String) params.get("objectId");

        // It is wise to use a StringBuffer
        // when concatenating large strings
        StringBuilder xml = new StringBuilder();
        xml.append("<gantt-chart>");

        // TODO: Add graph definitions to the xml

        xml.append("</gantt-chart>");
        return xml.toString();
    }

    /**
     * Constructor.
     */
    public ${CLASSNAME}(Context ctx, String[] args) {}
}