Page History

Div

Excerpt

Syntax

Code Block

language	none

set aString = anObject.classToExtendedJson()
set aString = anObject.classToExtendedJson(format)
set aString = anObject.classToExtendedJson(options)

Semantics

The operation classToExtendedJson() takes any object (anObject) and tries to map it to an Extended JSON string aString.

Info
In opposition to classToJSON, `classToExtendedJson()` preserves the order of attributes of the converted class. JSON types and xUML types are mapped as listed in chapter jsonToClass. These details also refer to Extended JSON.

If the conversion is not possible, an error is raised.

Info
`classToExtendedJSON()` does not support cyclic structures. When a cyclic structure is detected during serializing the given object, an exception will be thrown.

Substitutables anObject Any object.

aString Target Extended JSON document as String.

format String that specifies the format of the Extended JSON that should be produced (more details see options below).

options

This optional parameter is an object of type ExtendedJSONComposerOptions.

Its attributes are:

Attribute Type Description Allowed Values

format String Use format to specify which kind of Extended JSON should be produced: canonical or relaxed Extended JSON. canonical Produce canonical Extended JSON (default).

relaxed Produce relaxed Extended JSON.

keepNulls Boolean When keepNulls is true, attributes of anObject with NULL values will be rendered to the Extended JSON object, otherwise they will be left out completely (see also chapter NULL Values). The default behavior of classToJson() (i.e. when called without options) is equivalent to keepNulls=false. true Render NULL attributes to the Extended JSON string.

false Leave out NULL attributes (default).

writeTypeDiscriminator

Boolean

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	writeTypeDiscriminator
PageWithExcerpt	INTERNAL:_designer_excerpts_asl
shouldDisplayInlineCommentsInIncludes	false

This is necessary if you want to convert the generated Extended JSON back to an xUML class using extendedJSONToClass.

Info
In contrast to classToJSON, writeTypeDiscriminator defaults to false for `classToExtendedJson()`.

true

Write xUML type discriminator.

false Do not write xUML type discriminator (default).

Examples

Code Block

language	none

set aMongoDBdocument = myAddress.classToExtendedJson();set aMongoDBdocument = myAddress.classToExtendedJson("relaxed");

For more information on Extended JSON refer to MongoDB Extended JSON.

Div

Style	margin-top: -21px;

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	MongoDBAdapter_CustomerData_Example
PageWithExcerpt	INTERNAL:_designer_examples
shouldDisplayInlineCommentsInIncludes	false

rp

Panel

title	Related Pages:

rde

Panel

title	Related Documentation:

MongoDB Extended JSON

Page tree

Versions Compared

Old Version 3

New Version Current

Key