agi.foundation.cesium

(agi.foundation.cesium-2024r2.jar)

Class CzmlUpdateDocument

java.lang.Object

agi.foundation.cesium.CzmlUpdateDocument

All Implemented Interfaces:

ICzmlDocument

public class CzmlUpdateDocument
extends Object
implements ICzmlDocument

A CZML document which includes only the differences from the prior client state.

Method Summary

Modifier and Type	Method and Description
CzmlUpdateDocumentPacketizer	createStreamingDocument() Creates a CzmlUpdateDocumentPacketizer that can be used to stream CZML incrementally to a client.
CzmlUpdateDocumentPacketizer	createStreamingDocument(Writer writer) Creates a CzmlUpdateDocumentPacketizer that can be used to stream CZML incrementally to a client.
int	getPacketCount() Gets the number of CZML packets contained by this document.
boolean	getPrettyFormatting() Gets a value indicating whether the resulting CZML file is formatted using whitespace for easy readability, which will produce a significantly larger file.
void	setPrettyFormatting(boolean value) Sets a value indicating whether the resulting CZML file is formatted using whitespace for easy readability, which will produce a significantly larger file.
void	writeDocument(CesiumOutputStream outputStream) Writes the document to the provided output stream.
void	writeDocument(Writer writer) Writes the document to the provided writer.

Methods inherited from class java.lang.Object

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

Method Detail

getPrettyFormatting

public final boolean getPrettyFormatting()

Gets a value indicating whether the resulting CZML file is formatted using whitespace for easy readability, which will produce a significantly larger file. By default, this is set to false.

setPrettyFormatting

public final void setPrettyFormatting(boolean value)

Sets a value indicating whether the resulting CZML file is formatted using whitespace for easy readability, which will produce a significantly larger file. By default, this is set to false.

writeDocument

public final void writeDocument(Writer writer)

Writes the document to the provided writer.

Specified by:

writeDocument in interface ICzmlDocument

Parameters:

writer - The writer to use.

writeDocument

public final void writeDocument(CesiumOutputStream outputStream)

Writes the document to the provided output stream.

Specified by:

writeDocument in interface ICzmlDocument

Parameters:

outputStream - The output stream to use.

createStreamingDocument

@Nonnull
public final CzmlUpdateDocumentPacketizer createStreamingDocument(@Nonnull
                                                                            Writer writer)

Creates a CzmlUpdateDocumentPacketizer that can be used to stream CZML incrementally to a client.

Parameters:

writer - The writer to use.

Returns:

A new CzmlUpdateDocumentPacketizer for this document.

createStreamingDocument

@Nonnull
public final CzmlUpdateDocumentPacketizer createStreamingDocument()

Creates a CzmlUpdateDocumentPacketizer that can be used to stream CZML incrementally to a client.

The resulting CzmlUpdateDocumentPacketizer must be given a writer to write each packet to by calling CzmlUpdateDocumentPacketizer.generateNextPacket(Writer).

Returns:

A new CzmlUpdateDocumentPacketizer for this document.

getPacketCount

public final int getPacketCount()

Gets the number of CZML packets contained by this document.

Note that a CZML document always starts with a document packet, so this will always be at least one.