Package de.iip_ecosphere.platform.support.aas.basyx

Class AasxPersistenceRecipe

java.lang.Object

de.iip_ecosphere.platform.support.aas.basyx.AbstractPersistenceRecipe

de.iip_ecosphere.platform.support.aas.basyx.AasxPersistenceRecipe

All Implemented Interfaces:

de.iip_ecosphere.platform.support.aas.PersistenceRecipe

class AasxPersistenceRecipe
extends AbstractPersistenceRecipe

Persistence recipe for AASX.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	AasxPersistenceRecipe.Relationship	Represents an AASX relationship.

Field Summary

Fields

Modifier and Type	Field	Description
private static de.iip_ecosphere.platform.support.FileFormat	AASX
private static Map<String,String>	CONTENT_TYPES
private static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor	Description
AasxPersistenceRecipe()	Creates a recipe instance.

Method Summary

Modifier and Type	Method	Description
private void	aasToStream(ZipOutputStream out, DocumentBuilderFactory factory, TransformerFactory transformerFactory, de.iip_ecosphere.platform.support.aas.Aas aas, List<AasxPersistenceRecipe.Relationship> rels)	Turns an AAS to stream.
private Document	createContentTypesXML(DocumentBuilderFactory factory)	Creates the content types XML from CONTENT_TYPES.
private Document	createRelsXML(DocumentBuilderFactory factory, List<AasxPersistenceRecipe.Relationship> rels)	Creates the relationships XML from the relationships in rels.
List<de.iip_ecosphere.platform.support.aas.Aas>	readFrom(File file)
private void	textToStream(ZipOutputStream out, String text)	Emits text file contents into the output stream.
private String	toFileName(String idShort)	Turns an AAS name into a file-compatible name.
void	writeTo(List<de.iip_ecosphere.platform.support.aas.Aas> aas, File file)
private void	xmlToStream(ZipOutputStream out, TransformerFactory transformerFactory, Document doc)	Emits an XML document into the output streams.

Methods inherited from class de.iip_ecosphere.platform.support.aas.basyx.AbstractPersistenceRecipe

addAsset, getSupportedFormats, isValidForWriting, transform

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

AASX

private static final de.iip_ecosphere.platform.support.FileFormat AASX

CONTENT_TYPES

private static final Map<String,String> CONTENT_TYPES

Constructor Details

AasxPersistenceRecipe

AasxPersistenceRecipe()

Creates a recipe instance.

Method Details

writeTo

public void writeTo(List<de.iip_ecosphere.platform.support.aas.Aas> aas, File file) throws IOException

Throws:

IOException

toFileName

private String toFileName(String idShort)

Turns an AAS name into a file-compatible name.

Parameters:

idShort - the short name

Returns:

the transformed name

aasToStream

private void aasToStream(ZipOutputStream out, DocumentBuilderFactory factory, TransformerFactory transformerFactory, de.iip_ecosphere.platform.support.aas.Aas aas, List<AasxPersistenceRecipe.Relationship> rels) throws IOException, ParserConfigurationException, TransformerException

Turns an AAS to stream.

Parameters:

out - the output ZIP stream

factory - the XML document factory

transformerFactory - the XML transformer factory

aas - the AAS to be turned into the stream

rels - the AAS-level relationships to be modified with an added relationship for aas

Throws:

IOException - in case that stream writing fails

ParserConfigurationException - in case that the XML parser configuration is erroneous

TransformerException - in case that writing the XML through transformation fails

createContentTypesXML

private Document createContentTypesXML(DocumentBuilderFactory factory) throws ParserConfigurationException

Creates the content types XML from CONTENT_TYPES.

Parameters:

factory - the XML document factory

Returns:

the XML document containing the content types

Throws:

ParserConfigurationException - in case that the XML parser configuration is erroneous

createRelsXML

private Document createRelsXML(DocumentBuilderFactory factory, List<AasxPersistenceRecipe.Relationship> rels) throws ParserConfigurationException

Creates the relationships XML from the relationships in rels.

Parameters:

factory - the XML document factory

rels - the relationships to emit

Returns:

the XML document containing the relationships

Throws:

ParserConfigurationException - in case that the XML parser configuration is erroneous

xmlToStream

private void xmlToStream(ZipOutputStream out, TransformerFactory transformerFactory, Document doc) throws TransformerException

Emits an XML document into the output streams.

Parameters:

out - the output stream

transformerFactory - the XML transformer factory to use

doc - the XML document to emit

Throws:

TransformerException - in case that writing the XML through transformation fails

textToStream

private void textToStream(ZipOutputStream out, String text)

Emits text file contents into the output stream.

Parameters:

out - the output stream

text - the text to emit

readFrom

public List<de.iip_ecosphere.platform.support.aas.Aas> readFrom(File file) throws IOException

Throws:

IOException