Class InMemoryBcmSerializer

In-memory partial bcm serializer

Inheritance
System.Object
AbstractPartialBcmSerializer
InMemoryBcmSerializer
Implements
System.IDisposable
Inherited Members
Namespace: Sdl.Core.Bcm.BcmModel.PartialSerialization.InMemory
Assembly: Sdl.Core.Bcm.BcmModel.dll
Syntax
public sealed class InMemoryBcmSerializer : AbstractPartialBcmSerializer, IPartialBcmSerializer

Constructors

InMemoryBcmSerializer()

New empty document

Declaration
public InMemoryBcmSerializer()

InMemoryBcmSerializer(Document)

Constructor from Document instance

Declaration
public InMemoryBcmSerializer(Document fullDocument)
Parameters
Type Name Description
Document fullDocument

InMemoryBcmSerializer(String, Boolean)

Constructor from file path

Declaration
public InMemoryBcmSerializer(string filePath, bool deleteFile)
Parameters
Type Name Description
System.String filePath
System.Boolean deleteFile

Methods

AddFile(File)

Adds a file, based on the attributes and skeleton in the parameter. Array of paragraph units must be empty.

Declaration
public override void AddFile(File file)
Parameters
Type Name Description
File file
Overrides

DeleteFile(Int32)

Deletes the file from the document.

Declaration
public override void DeleteFile(int index)
Parameters
Type Name Description
System.Int32 index
Overrides

DeleteFile(String)

Deletes the file from the document.

Declaration
public override void DeleteFile(string id)
Parameters
Type Name Description
System.String id
Overrides

Dispose(Boolean)

Dispose function to override in derived classes

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides

ExtractDocument()

Returns the document packed into a single Document instance

Declaration
public Document ExtractDocument()
Returns
Type Description
Document

GetDocumentWithoutFiles()

Gets document attributes and metadata without the files list. Updates made to the object returned will be reflected automatically in the result in case the updated bcm is requested.

Declaration
public override Document GetDocumentWithoutFiles()
Returns
Type Description
Document
Overrides

GetFileCount()

Number of files in this document

Declaration
public override int GetFileCount()
Returns
Type Description
System.Int32
Overrides

GetFileIds()

All file ids in this document

Declaration
public override IReadOnlyList<string> GetFileIds()
Returns
Type Description
System.Collections.Generic.IReadOnlyList<System.String>
Overrides

GetFileSerializer(String)

Gets serialization wrapper for specific file

Declaration
public override IPartialFileSerializer GetFileSerializer(string fileId)
Parameters
Type Name Description
System.String fileId
Returns
Type Description
IPartialFileSerializer
Overrides

InsertFile(Int32, File)

Inserts a file to a specific position, based on the attributes and skeleton in the parameter. Array of paragraph units must be empty.

Declaration
public override void InsertFile(int index, File file)
Parameters
Type Name Description
System.Int32 index
File file
Overrides

SaveAsJson(TextWriter)

Saves bcm document as single json object to TextWriter

Declaration
public override void SaveAsJson(TextWriter textWriter)
Parameters
Type Name Description
System.IO.TextWriter textWriter
Overrides

Implements

System.IDisposable