Package com._1c.g5.v8.dt.dcs.util

Class DcsV8Serializer

java.lang.Object

com._1c.g5.v8.dt.dcs.util.DcsV8Serializer

public class DcsV8Serializer
extends Object

Сериализатор/десериализатор схемы компоновки данных в платформенный xml

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DB_COPIES_XML_NAMESPACE
static final String	DCS_APEARANCE_TEMPLATE_XML_NAMESPACE
static final String	DCS_APEARANCE_TEMPLATE_XML_NAMESPACE_PREFIX
static final String	DCS_AREA_TEMPLATE_XML_NAMESPACE
static final String	DCS_AREA_TEMPLATE_XML_NAMESPACE_PREFIX
static final String	DCS_COMMON_XML_NAMESPACE
static final String	DCS_COMMON_XML_NAMESPACE_PREFIX
static final String	DCS_CORE_XML_NAMESPACE
static final String	DCS_CORE_XML_NAMESPACE_PREFIX
static final String	DCS_SCHEMA_XML_NAMESPACE
static final String	DCS_SETTINGS_XML_NAMESPACE
static final String	DCS_SETTINGS_XML_NAMESPACE_PREFIX
static final String	SPREADSHEET_XML_NAMESPACE
static final String	SPREADSHEET_XML_NAMESPACE_PREFIX

Constructor Summary

Constructors

Constructor	Description
DcsV8Serializer(IDtProject dtProject, Version version, IResourceLookup resourceLookup)	Constructor.
DcsV8Serializer(IDtProject dtProject, org.eclipse.emf.ecore.resource.Resource resource, IResourceLookup resourceLookup)	Constructor.
DcsV8Serializer(IResourceLookup resourceLookup)	Constructor.
DcsV8Serializer(org.eclipse.emf.ecore.resource.Resource resource, IResourceLookup resourceLookup)	Deprecated. Use constructor with a IDtProject instead

Method Summary

Modifier and Type	Method	Description
IExportContext	createExportContext(IDtProject dtProject)	Creates actual IExportContext for writing DCS elements to xml
IExportContext	createExportContext(org.eclipse.core.resources.IProject project, Version version)	Creates actual IExportContext for writing DCS elements to xml
DataCompositionSchema	deserializeXML(InputStream inputStream)	Десериализовать схему компоновки данных из файла xml
DataCompositionAppearanceTemplate	readAppearanceTemplate(XMLStreamReader reader)	Reads DataCompositionAppearanceTemplate from xml.
DataCompositionSchemaCalculatedField	readCalculatedField(XMLStreamReader reader, Version version)	Reads DataCompositionSchemaCalculatedField from xml.
DataCompositionConditionalAppearance	readConditionalAppearance(XMLStreamReader reader)	Read ConditionalAppearance from xml
DataSetField	readDataSetField(XMLStreamReader reader, Version version)	Reads DataSetField from xml.
DataCompositionSchemaParameter	readParameter(XMLStreamReader reader, Version version)	Reads DataCompositionSchemaParameter from xml.
DataCompositionSchema	readSchema(XMLStreamReader reader)	Прочитать схему
DataCompositionSettings	readSettings(XMLStreamReader reader)	Прочитать настройки
void	serializeXML(DataCompositionAppearanceTemplate appearanceTemplate, OutputStream outputStream, IExportContext exportContext, Map<String,UUID> definedTypes, String lineSeparator)	Serializes DataCompositionAppearanceTemplate in xml stream.
void	serializeXML(DataCompositionSchema schema, OutputStream outputStream, IExportContext exportContext, Map<String,UUID> definedTypes, String lineSeparator)	Serializes DataCompositionSchema to xml format
void	serializeXML(org.eclipse.emf.ecore.EObject eObject, OutputStream outputStream, String lineSeparator, IDtProject dtProject)	Serializes EObject in xml stream.
void	writeAppearanceTemplate(ExportXmlStreamWriter writer, DataCompositionAppearanceTemplate appearanceTemplate, QName elementName, Map<String,UUID> definedTypes)	Writes DataCompositionAppearanceTemplate in xml stream.
void	writeCalculatedField(ExportXmlStreamWriter writer, DataCompositionSchemaCalculatedField field, QName elementName, IDtProject project)	Writes DataCompositionSchemaCalculatedField in xml stream.
void	writeConditionalAppearance(ExportXmlStreamWriter writer, DataCompositionConditionalAppearance appearance, QName elementName)	write ConditionalAppearance in xml stream
void	writeDataSetField(ExportXmlStreamWriter writer, DataSetField field, QName elementName, IDtProject project)	Writes DataSetField in xml stream.
void	writeDcsscaResource(ExportContextXmlStreamWriter writer, DataCompositionConditionalAppearance appearance)	Writes DataCompositionConditionalAppearance to xml stream
void	writeParameter(ExportXmlStreamWriter writer, DataCompositionSchemaParameter parameter, QName elementName, IDtProject project)	Writes DataCompositionSchemaParameter in xml stream.
void	writeSchema(ExportContextXmlStreamWriter writer, DataCompositionSchema schema, QName elementName, Version version, Map<String,UUID> definedTypes)	Writes the schema
void	writeSettings(ExportContextXmlStreamWriter writer, DataCompositionSettings settings, QName elementName, IDtProject project)	Writes DataCompositionSettings to xml stream

Methods inherited from class java.lang.Object

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

Field Details

DCS_SCHEMA_XML_NAMESPACE

public static final String DCS_SCHEMA_XML_NAMESPACE

See Also:

• Constant Field Values

DCS_COMMON_XML_NAMESPACE

public static final String DCS_COMMON_XML_NAMESPACE

See Also:

• Constant Field Values

DCS_COMMON_XML_NAMESPACE_PREFIX

public static final String DCS_COMMON_XML_NAMESPACE_PREFIX

See Also:

• Constant Field Values

DCS_CORE_XML_NAMESPACE

public static final String DCS_CORE_XML_NAMESPACE

See Also:

• Constant Field Values

DCS_CORE_XML_NAMESPACE_PREFIX

public static final String DCS_CORE_XML_NAMESPACE_PREFIX

See Also:

• Constant Field Values

DCS_SETTINGS_XML_NAMESPACE

public static final String DCS_SETTINGS_XML_NAMESPACE

See Also:

• Constant Field Values

DCS_SETTINGS_XML_NAMESPACE_PREFIX

public static final String DCS_SETTINGS_XML_NAMESPACE_PREFIX

See Also:

• Constant Field Values

DCS_AREA_TEMPLATE_XML_NAMESPACE

public static final String DCS_AREA_TEMPLATE_XML_NAMESPACE

See Also:

• Constant Field Values

DCS_AREA_TEMPLATE_XML_NAMESPACE_PREFIX

public static final String DCS_AREA_TEMPLATE_XML_NAMESPACE_PREFIX

See Also:

• Constant Field Values

DCS_APEARANCE_TEMPLATE_XML_NAMESPACE

public static final String DCS_APEARANCE_TEMPLATE_XML_NAMESPACE

See Also:

• Constant Field Values

DCS_APEARANCE_TEMPLATE_XML_NAMESPACE_PREFIX

public static final String DCS_APEARANCE_TEMPLATE_XML_NAMESPACE_PREFIX

See Also:

• Constant Field Values

DB_COPIES_XML_NAMESPACE

public static final String DB_COPIES_XML_NAMESPACE

See Also:

• Constant Field Values

SPREADSHEET_XML_NAMESPACE

public static final String SPREADSHEET_XML_NAMESPACE

See Also:

• Constant Field Values

SPREADSHEET_XML_NAMESPACE_PREFIX

public static final String SPREADSHEET_XML_NAMESPACE_PREFIX

See Also:

• Constant Field Values

Constructor Details

DcsV8Serializer

@Inject
public DcsV8Serializer(IResourceLookup resourceLookup)

Constructor.

Parameters:

resourceLookup - the resource lookup, can not be null

DcsV8Serializer

@Deprecated
public DcsV8Serializer(org.eclipse.emf.ecore.resource.Resource resource,
 IResourceLookup resourceLookup)

Deprecated.

Use constructor with a IDtProject instead

Constructor.

Parameters:

resource - dcs resource, can not be null

resourceLookup - the resource lookup, can not be null

DcsV8Serializer

public DcsV8Serializer(IDtProject dtProject,
 org.eclipse.emf.ecore.resource.Resource resource,
 IResourceLookup resourceLookup)

Constructor.

Parameters:

dtProject - The target IDtProject, can not be null

resource - dcs resource, can not be null

resourceLookup - the resource lookup, can not be null

DcsV8Serializer

public DcsV8Serializer(IDtProject dtProject,
 Version version,
 IResourceLookup resourceLookup)

Constructor.

Parameters:

resourceLookup - the resource lookup, can not be null

Method Details

deserializeXML

public DataCompositionSchema deserializeXML(InputStream inputStream)
                                     throws XMLStreamException,
ExportException

Десериализовать схему компоновки данных из файла xml

Parameters:

inputStream - файл

Returns:

схема

Throws:

XMLStreamException

ExportException - if export processing errors

serializeXML

public void serializeXML(org.eclipse.emf.ecore.EObject eObject,
 OutputStream outputStream,
 String lineSeparator,
 IDtProject dtProject)
                  throws XMLStreamException,
ExportException

Serializes EObject in xml stream.

Parameters:

eObject - the EObject instance, cannot be null

outputStream - the output stream, cannot be null

definedTypes - The set of defined types mapped to the defined type symlink, can be null

Throws:

XMLStreamException

ExportException - if export processing errors

serializeXML

public void serializeXML(DataCompositionSchema schema,
 OutputStream outputStream,
 IExportContext exportContext,
 Map<String,UUID> definedTypes,
 String lineSeparator)
                  throws XMLStreamException,
ExportException

Serializes DataCompositionSchema to xml format

Parameters:

schema - the target schema for writing, cannot be null

outputStream - the output stream for writing xml, cannot be null

exportContext - the export context, cannot be null

definedTypes - The set of defined types mapped to the defined type symlink, can be null

lineSeparator - actual line feed to use, cannot be null

Throws:

XMLStreamException - if an error occurred of write in stream

ExportException - if export processing errors

serializeXML

public void serializeXML(DataCompositionAppearanceTemplate appearanceTemplate,
 OutputStream outputStream,
 IExportContext exportContext,
 Map<String,UUID> definedTypes,
 String lineSeparator)
                  throws XMLStreamException,
ExportException

Serializes DataCompositionAppearanceTemplate in xml stream.

Parameters:

appearanceTemplate - the DataCompositionAppearanceTemplate instance, cannot be null

outputStream - the output stream, cannot be null

exportContext - the export context, cannot be null

Throws:

XMLStreamException

ExportException - if export processing errors

readSchema

public DataCompositionSchema readSchema(XMLStreamReader reader)
                                 throws XMLStreamException,
ExportException

Прочитать схему

Parameters:

reader -

Returns:

схема

Throws:

XMLStreamException

ExportException - if export processing errors

writeSchema

public void writeSchema(ExportContextXmlStreamWriter writer,
 DataCompositionSchema schema,
 QName elementName,
 Version version,
 Map<String,UUID> definedTypes)
                 throws XMLStreamException,
ExportException

Writes the schema

Parameters:

writer - The target writer. May not be null

schema - The target schema. May be null

elementName - The name of the element. May not be null

version - The platform version. May not be null

definedTypes - The set of configuration defined types mapped to teir UUIDs. May not be null

Throws:

XMLStreamException

ExportException

readSettings

public DataCompositionSettings readSettings(XMLStreamReader reader)
                                     throws XMLStreamException,
ExportException

Прочитать настройки

Parameters:

reader -

Returns:

настройки

Throws:

XMLStreamException

ExportException - if export processing errors

writeSettings

public void writeSettings(ExportContextXmlStreamWriter writer,
 DataCompositionSettings settings,
 QName elementName,
 IDtProject project)
                   throws XMLStreamException,
ExportException

Writes DataCompositionSettings to xml stream

Parameters:

writer - actual ExportContextXmlStreamWriter for creating xml, cannot be null

settings - DataCompositionSettings for writing, cannot be null

elementName - root element name, cannot be null

project - actual IDtProject, can be null if there is no context project

Throws:

XMLStreamException - if xml errors was occurred

ExportException - if export processing errors

writeDcsscaResource

public void writeDcsscaResource(ExportContextXmlStreamWriter writer,
 DataCompositionConditionalAppearance appearance)
                         throws XMLStreamException,
ExportException

Writes DataCompositionConditionalAppearance to xml stream

Parameters:

writer - the ExportContextXmlStreamWriter for creating xml, cannot be null

appearance - the DataCompositionConditionalAppearance object for writing, cannot be null

Throws:

XMLStreamException - if an error occurred of write in stream

ExportException - if export processing errors

readConditionalAppearance

public DataCompositionConditionalAppearance readConditionalAppearance(XMLStreamReader reader)
                                                               throws XMLStreamException,
ExportException

Read ConditionalAppearance from xml

Parameters:

reader - the XMLStreamReader

Returns:

the DataCompositionConditionalAppearance instance

Throws:

XMLStreamException

ExportException - if export processing errors

writeConditionalAppearance

public void writeConditionalAppearance(ExportXmlStreamWriter writer,
 DataCompositionConditionalAppearance appearance,
 QName elementName)
                                throws XMLStreamException,
ExportException

write ConditionalAppearance in xml stream

Parameters:

writer - the ExportXmlStreamWriter

appearance - the DataCompositionConditionalAppearance object

elementName - the name of xml element

Throws:

XMLStreamException

ExportException - if export processing errors

readAppearanceTemplate

public DataCompositionAppearanceTemplate readAppearanceTemplate(XMLStreamReader reader)
                                                         throws XMLStreamException,
ExportException

Reads DataCompositionAppearanceTemplate from xml.

Parameters:

reader - the XMLStreamReader, cannot be null

Returns:

the DataCompositionAppearanceTemplate instance, cannot be null

Throws:

XMLStreamException

ExportException - if export processing errors

writeAppearanceTemplate

public void writeAppearanceTemplate(ExportXmlStreamWriter writer,
 DataCompositionAppearanceTemplate appearanceTemplate,
 QName elementName,
 Map<String,UUID> definedTypes)
                             throws XMLStreamException,
ExportException

Writes DataCompositionAppearanceTemplate in xml stream.

Parameters:

writer - the ExportXmlStreamWriter, cannot be null

appearanceTemplate - the DataCompositionAppearanceTemplate instance, cannot be null

elementName - the name of xml element, cannot be null

Throws:

XMLStreamException

ExportException - if export processing errors

readDataSetField

public DataSetField readDataSetField(XMLStreamReader reader,
 Version version)
                              throws XMLStreamException,
ExportException

Reads DataSetField from xml.

Parameters:

reader - the XMLStreamReader, cannot be null

version - actual platform Version, cannot be null

Returns:

the DataSetField instance, cannot be null

Throws:

XMLStreamException

ExportException - if export processing errors

readCalculatedField

public DataCompositionSchemaCalculatedField readCalculatedField(XMLStreamReader reader,
 Version version)
                                                         throws XMLStreamException,
ExportException

Reads DataCompositionSchemaCalculatedField from xml.

Parameters:

reader - the XMLStreamReader, cannot be null

version - actual platform Version, cannot be null

Returns:

the DataCompositionSchemaCalculatedField instance, cannot be null

Throws:

XMLStreamException

ExportException - if export processing errors

readParameter

public DataCompositionSchemaParameter readParameter(XMLStreamReader reader,
 Version version)
                                             throws XMLStreamException,
ExportException

Reads DataCompositionSchemaParameter from xml.

Parameters:

reader - the XMLStreamReader, cannot be null

version - actual platform Version, cannot be null

Returns:

the DataCompositionSchemaParameter instance, cannot be null

Throws:

XMLStreamException

ExportException - if export processing errors

writeDataSetField

public void writeDataSetField(ExportXmlStreamWriter writer,
 DataSetField field,
 QName elementName,
 IDtProject project)
                       throws XMLStreamException,
ExportException

Writes DataSetField in xml stream.

Parameters:

writer - the ExportXmlStreamWriter, cannot be null

field - the DataCompositionAppearanceTemplate instance, cannot be null

elementName - the name of xml element, cannot be null

project - actual IDtProject for getting definedTypes form it, can be null

Throws:

XMLStreamException

ExportException - if export processing errors

writeCalculatedField

public void writeCalculatedField(ExportXmlStreamWriter writer,
 DataCompositionSchemaCalculatedField field,
 QName elementName,
 IDtProject project)
                          throws XMLStreamException,
ExportException

Writes DataCompositionSchemaCalculatedField in xml stream.

Parameters:

writer - the ExportXmlStreamWriter, cannot be null

field - the DataCompositionAppearanceTemplate instance, cannot be null

elementName - the name of xml element, cannot be null

project - actual IDtProject for getting definedTypes form it, can be null

Throws:

XMLStreamException

ExportException - if export processing errors

writeParameter

public void writeParameter(ExportXmlStreamWriter writer,
 DataCompositionSchemaParameter parameter,
 QName elementName,
 IDtProject project)
                    throws XMLStreamException,
ExportException

Writes DataCompositionSchemaParameter in xml stream.

Parameters:

writer - the ExportXmlStreamWriter, cannot be null

field - the DataCompositionAppearanceTemplate instance, cannot be null

elementName - the name of xml element, cannot be null

project - actual IDtProject for getting definedTypes form it, can be null

Throws:

XMLStreamException

ExportException - if export processing errors

createExportContext

public IExportContext createExportContext(IDtProject dtProject)

Creates actual IExportContext for writing DCS elements to xml

Parameters:

dtProject - current IDtProject for giving actual platform version, cannot be null

Returns:

created actual IExportContext for writing DCS elements to xml, never null

createExportContext

public IExportContext createExportContext(org.eclipse.core.resources.IProject project,
 Version version)

Creates actual IExportContext for writing DCS elements to xml

Parameters:

project - current IProject for export DCS elements to xml, cannot be null

version - current Version for export DCS elements to xml, cannot be null

Returns:

created actual IExportContext for writing DCS elements to xml, never null