org.bimserver.plugins.serializers

Interface Serializer

All Superinterfaces:

StreamingReader

All Known Implementing Classes:

AbstractGeometrySerializer, EmfSerializer

public interface Serializer
extends StreamingReader

Author:

Ruben de Laat A serializer serializes model data to a stream. Serializers can only be used once (in previous versions they could be use multiple times and had a reset() method).

Method Summary

Modifier and Type	Method and Description
default boolean	allowCaching()
void	init(IfcModelInterface model, ProjectInfo projectInfo, boolean normalizeOids) Initialize this serializer
void	writeToOutputStream(OutputStream outputStream, ProgressReporter progressReporter)

Methods inherited from interface org.bimserver.plugins.serializers.StreamingReader

write

Method Detail

init

void init(IfcModelInterface model,
          ProjectInfo projectInfo,
          boolean normalizeOids)
   throws SerializerException

Initialize this serializer

Parameters:

model - The model that will be serialized

projectInfo - ProjectInformation that is stored in the BIMserver project

pluginManager - PluginManager that can be used to call other plugins

normalizeOids - Whether to normalize the oids (usually means the oid will be regenerated from 1)

Throws:

SerializerException

writeToOutputStream

void writeToOutputStream(OutputStream outputStream,
                         ProgressReporter progressReporter)
                  throws SerializerException

Parameters:

outputStream - The stream to write to

progressReporter - An interface you can use to report progress

Throws:

SerializerException

allowCaching

default boolean allowCaching()

Returns:

Whether the results of this serializer can be cached by BIMserver, defaults to true