org.bimserver.plugins.serializers

Interface SerializerPlugin

All Superinterfaces:

Plugin

All Known Implementing Classes:

AbstractSerializerPlugin

public interface SerializerPlugin
extends Plugin

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE
static String	EXTENSION
static String	ZIP_EXTENSION

Method Summary

Modifier and Type	Method and Description
Serializer	createSerializer(PluginConfiguration plugin)
String	getOutputFormat(Schema schema)
default SPluginType	getPluginType()
Set<Schema>	getSupportedSchemas()
boolean	needsGeometry()

Methods inherited from interface org.bimserver.plugins.Plugin

getSettingsDefinition, init

Field Detail

EXTENSION

static final String EXTENSION

See Also:

Constant Field Values

ZIP_EXTENSION

static final String ZIP_EXTENSION

See Also:

Constant Field Values

CONTENT_TYPE

static final String CONTENT_TYPE

See Also:

Constant Field Values

Method Detail

createSerializer

Serializer createSerializer(PluginConfiguration plugin)

Returns:

A serializer

getSupportedSchemas

Set<Schema> getSupportedSchemas()

Returns:

The schemas supported by this serializer

getOutputFormat

String getOutputFormat(Schema schema)

Returns:

The output format this serializer outputs when the given Schema is used as the input. These formats have not been standardized, but a list is available on https://github.com/opensourceBIM/BIMserver/wiki/New-remote-service-interface#namespaces

getPluginType

default SPluginType getPluginType()

Specified by:

getPluginType in interface Plugin

Returns:

Returns the type of plugin, should be implemented by all underlying interfaces, and not by the actual plugins

needsGeometry

boolean needsGeometry()

Returns:

Whether this plugin will be needing geometry