org.apache.ambari.server.api.services.serializers

Class CsvSerializer

java.lang.Object

org.apache.ambari.server.api.services.serializers.CsvSerializer

All Implemented Interfaces:

ResultSerializer

public class CsvSerializer
extends Object
implements ResultSerializer

CSV serializer used to generate a CSV-formatted document from a result.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_COLUMN_MAP Property name for the CsvSerializer-specific column map where the value of this property contains a map of resource property names to header descriptive names.
static String	PROPERTY_COLUMN_ORDER Property name for the CsvSerializer-specific column order where the value of this property contains a list of resource property names in the order to export.

Constructor Summary

Constructors

Constructor and Description
CsvSerializer()

Method Summary

Modifier and Type	Method and Description
Object	serialize(Result result) Serialize the result into a CSV-formatted text document.
Object	serializeError(ResultStatus error) Serialize an error result to the format expected by the client.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_COLUMN_MAP

public static final String PROPERTY_COLUMN_MAP

Property name for the CsvSerializer-specific column map where the value of this property contains a map of resource property names to header descriptive names.

If not specified, no header record will be serialized.

See Also:

Constant Field Values

PROPERTY_COLUMN_ORDER

public static final String PROPERTY_COLUMN_ORDER

Property name for the CsvSerializer-specific column order where the value of this property contains a list of resource property names in the order to export.

If not specified, the order will be taken from key order in the csv_column_map property (if available) or from the "natural" order of the properties in the resource.

See Also:

Constant Field Values

Constructor Detail

CsvSerializer

public CsvSerializer()

Method Detail

serialize

public Object serialize(Result result)

Serialize the result into a CSV-formatted text document.

It is expected that the result set is a collection of flat resources - no sub-resources will be included in the output. The root of the tree structure may have a column map (csv_column_map) and a column order (csv_column_order) property set to indicate the header record and ordering of the columns.

The csv_column_map is a map of resource property names to header descriptive names. If not specified, a header record will not be serialized.

The csv_column_order is a list of resource property names declaring the order of the columns. If not specified, the order will be taken from the key order of csv_column_map or the "natural" ordering of the resource property names, both may be unpredictable.

Specified by:

serialize in interface ResultSerializer

Parameters:

result - internal result

Returns:

a String containing the CSV-formatted document

serializeError

public Object serializeError(ResultStatus error)

Description copied from interface: ResultSerializer

Serialize an error result to the format expected by the client.

Specified by:

serializeError in interface ResultSerializer

Parameters:

error - the error result

Returns:

the serialized error result