Javadoc fix
This commit is contained in:
Doug Pedrick
parent
ca52cc6612
commit
df7ab36b5a
@ -1,5 +1,13 @@
|
||||
package net.sf.openrocket.preset.xml;
|
||||
|
||||
import net.sf.openrocket.material.Material;
|
||||
import net.sf.openrocket.preset.ComponentPreset;
|
||||
import net.sf.openrocket.preset.InvalidComponentPresetException;
|
||||
|
||||
import javax.xml.bind.JAXBContext;
|
||||
import javax.xml.bind.JAXBException;
|
||||
import javax.xml.bind.Marshaller;
|
||||
import javax.xml.bind.Unmarshaller;
|
||||
import java.io.BufferedWriter;
|
||||
import java.io.IOException;
|
||||
import java.io.OutputStream;
|
||||
@ -8,134 +16,131 @@ import java.io.Reader;
|
||||
import java.io.StringWriter;
|
||||
import java.util.List;
|
||||
|
||||
import javax.xml.bind.JAXBContext;
|
||||
import javax.xml.bind.JAXBException;
|
||||
import javax.xml.bind.Marshaller;
|
||||
import javax.xml.bind.Unmarshaller;
|
||||
|
||||
import net.sf.openrocket.material.Material;
|
||||
import net.sf.openrocket.preset.ComponentPreset;
|
||||
import net.sf.openrocket.preset.InvalidComponentPresetException;
|
||||
|
||||
/**
|
||||
* The active manager class that is the entry point for writing *.orc files.
|
||||
* The active manager class that is the entry point for reading and writing *.orc files.
|
||||
*/
|
||||
public class OpenRocketComponentSaver {
|
||||
|
||||
/**
|
||||
* This method marshals an OpenRocketDocument (OR design) to Rocksim-compliant XML.
|
||||
*
|
||||
* @param theMaterialList the list of materials to be included
|
||||
* @param thePresetList the list of presets to be included
|
||||
*
|
||||
* @return ORC-compliant XML
|
||||
* @throws JAXBException
|
||||
*/
|
||||
public String marshalToOpenRocketComponent(List<Material> theMaterialList, List<ComponentPreset> thePresetList) throws JAXBException {
|
||||
/**
|
||||
* This method marshals a list of materials and ComponentPresets into an .orc formatted XML string.
|
||||
*
|
||||
* @param theMaterialList the list of materials to be included
|
||||
* @param thePresetList the list of presets to be included
|
||||
*
|
||||
* @return ORC-compliant XML
|
||||
*
|
||||
* @throws JAXBException
|
||||
*/
|
||||
public String marshalToOpenRocketComponent(List<Material> theMaterialList, List<ComponentPreset> thePresetList) throws
|
||||
JAXBException {
|
||||
|
||||
JAXBContext binder = JAXBContext.newInstance(OpenRocketComponentDTO.class);
|
||||
Marshaller marshaller = binder.createMarshaller();
|
||||
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
|
||||
StringWriter sw = new StringWriter();
|
||||
JAXBContext binder = JAXBContext.newInstance(OpenRocketComponentDTO.class);
|
||||
Marshaller marshaller = binder.createMarshaller();
|
||||
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
|
||||
StringWriter sw = new StringWriter();
|
||||
|
||||
marshaller.marshal(toOpenRocketComponentDTO(theMaterialList, thePresetList), sw);
|
||||
return sw.toString();
|
||||
marshaller.marshal(toOpenRocketComponentDTO(theMaterialList, thePresetList), sw);
|
||||
return sw.toString();
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This method unmarshals from a Reader that is presumed to be open on an XML file in .orc format.
|
||||
*
|
||||
* @param is an open reader; StringBufferInputStream could not be used because it's deprecated and does not handle
|
||||
* UTF characters correctly
|
||||
*
|
||||
* @return a list of ComponentPresets
|
||||
*
|
||||
* @throws InvalidComponentPresetException
|
||||
*
|
||||
*/
|
||||
public List<ComponentPreset> unmarshalFromOpenRocketComponent(Reader is) throws JAXBException, InvalidComponentPresetException {
|
||||
return fromOpenRocketComponent(is).asComponentPresets();
|
||||
}
|
||||
/**
|
||||
* This method unmarshals from a Reader that is presumed to be open on an XML file in .orc format.
|
||||
*
|
||||
* @param is an open reader; StringBufferInputStream could not be used because it's deprecated and does not handle UTF
|
||||
* characters correctly
|
||||
*
|
||||
* @return a list of ComponentPresets
|
||||
*
|
||||
* @throws InvalidComponentPresetException
|
||||
*
|
||||
*/
|
||||
public List<ComponentPreset> unmarshalFromOpenRocketComponent(Reader is) throws JAXBException,
|
||||
InvalidComponentPresetException {
|
||||
return fromOpenRocketComponent(is).asComponentPresets();
|
||||
}
|
||||
|
||||
/**
|
||||
* Write an XML representation of a list of presets.
|
||||
*
|
||||
* @param dest the stream to write the data to
|
||||
* @param theMaterialList the list of materials to be included
|
||||
* @param thePresetList the list of presets to be included
|
||||
* @throws JAXBException
|
||||
* @throws IOException thrown if the stream could not be written
|
||||
*/
|
||||
public void save(OutputStream dest, List<Material> theMaterialList, List<ComponentPreset> thePresetList) throws IOException, JAXBException {
|
||||
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(dest, "UTF-8"));
|
||||
writer.write(marshalToOpenRocketComponent(theMaterialList, thePresetList));
|
||||
writer.flush();
|
||||
writer.close();
|
||||
}
|
||||
/**
|
||||
* Write an XML representation of a list of presets.
|
||||
*
|
||||
* @param dest the stream to write the data to
|
||||
* @param theMaterialList the list of materials to be included
|
||||
* @param thePresetList the list of presets to be included
|
||||
*
|
||||
* @throws JAXBException
|
||||
* @throws IOException thrown if the stream could not be written
|
||||
*/
|
||||
public void save(OutputStream dest, List<Material> theMaterialList, List<ComponentPreset> thePresetList) throws
|
||||
IOException,
|
||||
JAXBException {
|
||||
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(dest, "UTF-8"));
|
||||
writer.write(marshalToOpenRocketComponent(theMaterialList, thePresetList));
|
||||
writer.flush();
|
||||
writer.close();
|
||||
}
|
||||
|
||||
/**
|
||||
* Read from an open Reader instance XML in .orc format and reconstruct an OpenRocketComponentDTO instance.
|
||||
*
|
||||
* @param is an open Reader; assumed to be opened on a file of XML in .orc format
|
||||
*
|
||||
* @return the OpenRocketComponentDTO that is a POJO representation of the XML; null if the data could not be read
|
||||
* or was in an invalid format
|
||||
*/
|
||||
private OpenRocketComponentDTO fromOpenRocketComponent(Reader is) throws JAXBException {
|
||||
JAXBContext bind = JAXBContext.newInstance(OpenRocketComponentDTO.class);
|
||||
Unmarshaller unmarshaller = bind.createUnmarshaller();
|
||||
return (OpenRocketComponentDTO) unmarshaller.unmarshal(is);
|
||||
}
|
||||
/**
|
||||
* Read from an open Reader instance XML in .orc format and reconstruct an OpenRocketComponentDTO instance.
|
||||
*
|
||||
* @param is an open Reader; assumed to be opened on a file of XML in .orc format
|
||||
*
|
||||
* @return the OpenRocketComponentDTO that is a POJO representation of the XML; null if the data could not be read or
|
||||
* was in an invalid format
|
||||
*/
|
||||
private OpenRocketComponentDTO fromOpenRocketComponent(Reader is) throws JAXBException {
|
||||
JAXBContext bind = JAXBContext.newInstance(OpenRocketComponentDTO.class);
|
||||
Unmarshaller unmarshaller = bind.createUnmarshaller();
|
||||
return (OpenRocketComponentDTO) unmarshaller.unmarshal(is);
|
||||
}
|
||||
|
||||
/**
|
||||
* Root conversion method. It iterates over all subcomponents.
|
||||
*
|
||||
* @return a corresponding ORC representation
|
||||
*/
|
||||
private OpenRocketComponentDTO toOpenRocketComponentDTO(List<Material> theMaterialList, List<ComponentPreset> thePresetList) {
|
||||
OpenRocketComponentDTO rsd = new OpenRocketComponentDTO();
|
||||
/**
|
||||
* Root conversion method. It iterates over all subcomponents.
|
||||
*
|
||||
* @return a corresponding ORC representation
|
||||
*/
|
||||
private OpenRocketComponentDTO toOpenRocketComponentDTO(List<Material> theMaterialList, List<ComponentPreset> thePresetList) {
|
||||
OpenRocketComponentDTO rsd = new OpenRocketComponentDTO();
|
||||
|
||||
if (theMaterialList != null) {
|
||||
for (Material material : theMaterialList) {
|
||||
rsd.addMaterial(new MaterialDTO(material));
|
||||
}
|
||||
}
|
||||
if (theMaterialList != null) {
|
||||
for (Material material : theMaterialList) {
|
||||
rsd.addMaterial(new MaterialDTO(material));
|
||||
}
|
||||
}
|
||||
|
||||
if (thePresetList != null) {
|
||||
for (ComponentPreset componentPreset : thePresetList) {
|
||||
rsd.addComponent(toComponentDTO(componentPreset));
|
||||
}
|
||||
}
|
||||
return rsd;
|
||||
}
|
||||
if (thePresetList != null) {
|
||||
for (ComponentPreset componentPreset : thePresetList) {
|
||||
rsd.addComponent(toComponentDTO(componentPreset));
|
||||
}
|
||||
}
|
||||
return rsd;
|
||||
}
|
||||
|
||||
/**
|
||||
* Factory method that maps a preset to the corresponding DTO handler.
|
||||
*
|
||||
* @param thePreset the preset for which a handler will be found
|
||||
*
|
||||
* @return a subclass of BaseComponentDTO that can be used for marshalling/unmarshalling a preset; null if not found
|
||||
* for the preset type
|
||||
*/
|
||||
private static BaseComponentDTO toComponentDTO(ComponentPreset thePreset) {
|
||||
switch (thePreset.getType()) {
|
||||
case BODY_TUBE:
|
||||
return new BodyTubeDTO(thePreset);
|
||||
case TUBE_COUPLER:
|
||||
return new TubeCouplerDTO(thePreset);
|
||||
case NOSE_CONE:
|
||||
return new NoseConeDTO(thePreset);
|
||||
case TRANSITION:
|
||||
return new TransitionDTO(thePreset);
|
||||
case BULK_HEAD:
|
||||
return new BulkHeadDTO(thePreset);
|
||||
case CENTERING_RING:
|
||||
return new CenteringRingDTO(thePreset);
|
||||
case ENGINE_BLOCK:
|
||||
return new EngineBlockDTO(thePreset);
|
||||
}
|
||||
/**
|
||||
* Factory method that maps a preset to the corresponding DTO handler.
|
||||
*
|
||||
* @param thePreset the preset for which a handler will be found
|
||||
*
|
||||
* @return a subclass of BaseComponentDTO that can be used for marshalling/unmarshalling a preset; null if not found
|
||||
* for the preset type
|
||||
*/
|
||||
private static BaseComponentDTO toComponentDTO(ComponentPreset thePreset) {
|
||||
switch (thePreset.getType()) {
|
||||
case BODY_TUBE:
|
||||
return new BodyTubeDTO(thePreset);
|
||||
case TUBE_COUPLER:
|
||||
return new TubeCouplerDTO(thePreset);
|
||||
case NOSE_CONE:
|
||||
return new NoseConeDTO(thePreset);
|
||||
case TRANSITION:
|
||||
return new TransitionDTO(thePreset);
|
||||
case BULK_HEAD:
|
||||
return new BulkHeadDTO(thePreset);
|
||||
case CENTERING_RING:
|
||||
return new CenteringRingDTO(thePreset);
|
||||
case ENGINE_BLOCK:
|
||||
return new EngineBlockDTO(thePreset);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user