JsonFormatter (Groovy Documentation)

com.cedarsoftware.ncube.formatters.JsonFormatter

All Implemented Interfaces and Traits:

NCubeFormatter
```
@groovy.transform.CompileStatic
class JsonFormatter
extends BaseJsonFormatter
```
Format an NCube into an JSON document
Authors:
Ken Partlow ([email protected]), John DeRegnaucourt ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License") you may not use this file except in compliance with the License. You may obtain axis copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`DEFAULT_COLUMN_PREFIX`

Inherited fields
Fields inherited from class	Fields
`class BaseJsonFormatter`	`dateFormat`

Constructor Summary

Constructors
Constructor and description
`JsonFormatter ()`
`JsonFormatter (java.io.OutputStream stream)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`format(NCube ncube, java.util.Map<java.lang.String, java.lang.Object> options = null)` Use this API to generate JSON view of this NCube.
	`void`	`formatCube(NCube ncube, java.util.Map<java.lang.String, java.lang.Object> options)`
	`static java.lang.String`	`getColumnType(java.lang.Object o)`
	`void`	`writeAxes(java.util.List<Axis> axes, java.util.Map<java.lang.String, java.lang.Object> options)`
	`void`	`writeAxis(Axis axis, java.util.Map<java.lang.String, java.lang.Object> options)`
	`void`	`writeCells(java.util.Map<java.util.Set<java.lang.Long>, java.lang.Object> cells, java.util.Map<java.lang.String, java.lang.Object> options)`
	`void`	`writeColumn(Column column, java.util.Map<java.lang.String, java.lang.Object> options)`
	`void`	`writeColumns(java.util.List<Column> columns, java.util.Map<java.lang.String, java.lang.Object> options)`
	`void`	`writeCommandCell(CommandCell cmd)`
	`void`	`writeId(java.lang.Long longId, boolean addComma)`
	`void`	`writeIdValue(java.lang.Long longId, boolean addComma)`
	`void`	`writeIds(java.util.Set<java.lang.Long> colIds)`
	`void`	`writeIndexAxis(Axis axis, java.util.Map<java.lang.String, java.lang.Object> options)`
	`void`	`writeType(java.lang.String type)` According to parseJsonValue reading in, if your item is one of the following end types it does not need to specify the end type: String, Long, Boolean, Double.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class BaseJsonFormatter`	`append, append, comma, endArray, endObject, startArray, startObject`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.lang.String DEFAULT_COLUMN_PREFIX
- Constructor Detail
  - JsonFormatter()
  - JsonFormatter(java.io.OutputStream stream)
- Method Detail
  - java.lang.String format(NCube ncube, java.util.Map<java.lang.String, java.lang.Object> options = null)
    
    Use this API to generate JSON view of this NCube.
  - void formatCube(NCube ncube, java.util.Map<java.lang.String, java.lang.Object> options)
  - static java.lang.String getColumnType(java.lang.Object o)
  - void writeAxes(java.util.List<Axis> axes, java.util.Map<java.lang.String, java.lang.Object> options)
  - void writeAxis(Axis axis, java.util.Map<java.lang.String, java.lang.Object> options)
  - void writeCells(java.util.Map<java.util.Set<java.lang.Long>, java.lang.Object> cells, java.util.Map<java.lang.String, java.lang.Object> options)
  - void writeColumn(Column column, java.util.Map<java.lang.String, java.lang.Object> options)
  - void writeColumns(java.util.List<Column> columns, java.util.Map<java.lang.String, java.lang.Object> options)
  - void writeCommandCell(CommandCell cmd)
  - void writeId(java.lang.Long longId, boolean addComma)
  - void writeIdValue(java.lang.Long longId, boolean addComma)
  - void writeIds(java.util.Set<java.lang.Long> colIds)
  - void writeIndexAxis(Axis axis, java.util.Map<java.lang.String, java.lang.Object> options)
  - void writeType(java.lang.String type)
    
    According to parseJsonValue reading in, if your item is one of the following end types it does not need to specify the end type: String, Long, Boolean, Double. These items will all be picked up automatically so to save on those types I don't write out the type.
    Parameters:
    type - Type to write, if null don't write anything because its axis default type

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class JsonFormatter

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String DEFAULT_COLUMN_PREFIX

Constructor Detail

JsonFormatter()

JsonFormatter(java.io.OutputStream stream)

Method Detail

java.lang.String format(NCube ncube, java.util.Map<java.lang.String, java.lang.Object> options = null)

void formatCube(NCube ncube, java.util.Map<java.lang.String, java.lang.Object> options)

static java.lang.String getColumnType(java.lang.Object o)

void writeAxes(java.util.List<Axis> axes, java.util.Map<java.lang.String, java.lang.Object> options)

void writeAxis(Axis axis, java.util.Map<java.lang.String, java.lang.Object> options)

void writeCells(java.util.Map<java.util.Set<java.lang.Long>, java.lang.Object> cells, java.util.Map<java.lang.String, java.lang.Object> options)

void writeColumn(Column column, java.util.Map<java.lang.String, java.lang.Object> options)

void writeColumns(java.util.List<Column> columns, java.util.Map<java.lang.String, java.lang.Object> options)

void writeCommandCell(CommandCell cmd)

void writeId(java.lang.Long longId, boolean addComma)

void writeIdValue(java.lang.Long longId, boolean addComma)

void writeIds(java.util.Set<java.lang.Long> colIds)

void writeIndexAxis(Axis axis, java.util.Map<java.lang.String, java.lang.Object> options)

void writeType(java.lang.String type)