001: package org.objectweb.salome_tmf.plugins.core;
002:
003: import java.io.File;
004:
005: import javax.swing.JPanel;
006:
007: import org.dom4j.Document;
008: import org.dom4j.Element;
009: import org.objectweb.salome_tmf.data.Action;
010: import org.objectweb.salome_tmf.data.Campaign;
011: import org.objectweb.salome_tmf.data.DataSet;
012: import org.objectweb.salome_tmf.data.Environment;
013: import org.objectweb.salome_tmf.data.Execution;
014: import org.objectweb.salome_tmf.data.ExecutionResult;
015: import org.objectweb.salome_tmf.data.ExecutionTestResult;
016: import org.objectweb.salome_tmf.data.Family;
017: import org.objectweb.salome_tmf.data.Parameter;
018: import org.objectweb.salome_tmf.data.Project;
019: import org.objectweb.salome_tmf.data.Test;
020: import org.objectweb.salome_tmf.data.TestList;
021:
022: public interface XMLPrinterPlugin {
023:
024: /************** Option Panel *************/
025:
026: JPanel getExportOptionPanel();
027:
028: JPanel getImportOptionPanel();
029:
030: /************** EXPORT *****************/
031: void addXMLElement2Root(Element rootElement,
032: XMLWriterPlugin pXMLWriter, String pathAttach);
033:
034: /* Test Plan */
035: void addXMLElement2Project(Element projectElement,
036: Project pProject, XMLWriterPlugin pXMLWriter,
037: String pathAttach);
038:
039: void addXMLElement2Family(Element familyElement, Family pFamily,
040: XMLWriterPlugin pXMLWriter, String pathAttach);
041:
042: void addXMLElement2Suite(Element suiteElement, TestList ptestList,
043: XMLWriterPlugin pXMLWriter, String pathAttach);
044:
045: void addXMLElement2Test(Element testElement, Test pTest,
046: XMLWriterPlugin pXMLWriter, String pathAttach);
047:
048: //void addXMLElement2ValuedParameter(Element paramElement, Test pTest, Parameter pParam);
049: void addXMLElement2Action(Element testElement, Action pAction,
050: XMLWriterPlugin pXMLWriter, String pathAttach);
051:
052: /* Campaing plan */
053: void addXMLElement2Campaign(Element campaignElement,
054: Campaign pcampaign, XMLWriterPlugin pXMLWriter,
055: String pathAttach);
056:
057: void addXMLElement2Execution(Element execElement,
058: Execution pExecution, XMLWriterPlugin pXMLWriter,
059: String pathAttach);
060:
061: void addXMLElement2ResExecution(Element resExecElement,
062: ExecutionResult pExecRes, XMLWriterPlugin pXMLWriter,
063: String pathAttach);
064:
065: void addXMLElement2ResTestExecution(Element resTestElem,
066: ExecutionTestResult pExecTestRes, Test pTest,
067: XMLWriterPlugin pXMLWriter, String pathAttach);
068:
069: void addXMLElement2DataSet(Element dataSetElement,
070: DataSet pDataSet, XMLWriterPlugin pXMLWriter,
071: String pathAttach);
072:
073: /* Data */
074: void addXMLElement2Parameter(Element paramElement,
075: Parameter pParam, XMLWriterPlugin pXMLWriter,
076: String pathAttach);
077:
078: void addXMLElement2Environment(Element envElement,
079: Environment pEnv, XMLWriterPlugin pXMLWriter,
080: String pathAttach);
081:
082: /**************** IMPORT *****************/
083: /**
084: * Called first before updateMethode if isSupOption = true
085: */
086: void manageDelete(Document doc, XMLLoaderPlugin pXMLLoader)
087: throws Exception;
088:
089: /* Test Plan */
090: void updateProjectFromXML(Document doc, boolean isSupOption,
091: Project project, XMLLoaderPlugin pXMLLoader)
092: throws Exception;
093:
094: void updateFamilyFromXML(Element familyElement, Family pFamily,
095: boolean isSupOption, XMLLoaderPlugin pXMLLoader)
096: throws Exception;
097:
098: void updateSuiteFromXML(Element suiteElement, TestList pSuite,
099: boolean isSupOption, XMLLoaderPlugin pXMLLoader)
100: throws Exception;
101:
102: void updateTestFromXML(Element testElement, Test pTest,
103: boolean isSupOption, XMLLoaderPlugin pXMLLoader)
104: throws Exception;
105:
106: void updateActionFromXML(Element actionElement, Action pAction,
107: boolean isSupOption, XMLLoaderPlugin pXMLLoader)
108: throws Exception;
109:
110: /* Campaing plan */
111: void updateCampaignFromXML(Element campaignElement,
112: Campaign pcampaign, boolean isSupOption,
113: XMLLoaderPlugin pXMLLoader) throws Exception;
114:
115: void updateExecutionFromXML(Element execElement,
116: Execution pExecution, boolean isSupOption,
117: XMLLoaderPlugin pXMLLoader) throws Exception;
118:
119: void updateResExecutionFromXML(Element resExecElement,
120: ExecutionResult pExecRes, boolean isSupOption,
121: XMLLoaderPlugin pXMLLoader) throws Exception;
122:
123: void updateDataSetFromXML(Element dataSetElement, DataSet pDataSet,
124: boolean isSupOption, XMLLoaderPlugin pXMLLoader)
125: throws Exception;
126:
127: /* Data */
128: void updateParameterFromXML(Element paramElement, Parameter pParam,
129: boolean isSupOption, XMLLoaderPlugin pXMLLoader)
130: throws Exception;
131:
132: void updateEnvironmentFromXML(Element envElement, Environment pEnv,
133: boolean isSupOption, XMLLoaderPlugin pXMLLoader)
134: throws Exception;
135:
136: /**
137: *
138: * Called last after import
139: */
140: void refreshNewData();
141:
142: /**************** XSLT ******************
143: * @param dynamicMode true if generated HTML report is the results' report, false otherwise
144: * @param multiFrame true if the generated HTML report is in multi-frame mode, false otherwise
145: */
146: File getXSLToImport(boolean dynamicMode, boolean multiFrame,
147: boolean htmlFormat);
148:
149: /**
150: * Get the translation file for the XSLT transformation
151: * @return the XML file for translation
152: */
153: File getTranslationFile();
154:
155: void setExport(boolean b);
156:
157: void setImport(boolean b);
158:
159: /**
160: * Gives the chapter title in the HTML report related to the concerned plugin.
161: * @return the title
162: */
163: String getChapterTitleInReport();
164:
165: /**
166: * Gives the name of the parameter for the XSLT transformation
167: * return null if the given chapter name does not correspond to the plugin title.
168: * @param chapterName
169: * @return
170: */
171: String getParameterName(String chapterName);
172: }
|