com.yahoo.bullet.rest.service

Class SchemaService

java.lang.Object

com.yahoo.bullet.rest.service.SchemaService

@Service
public class SchemaService
extends Object

Manages access to and provides the schema for the fields. Use setSchema(List) to set the schema. The schema is of the form:

 
     {
         "meta": { meta information },
         "data": [ the columns ]
     }
 Each entry in data is of the form:
     {
         "id": "a string id",
         "type": "field",
         "attributes": {
              "name": "the field name",
              "type": "one of BOOLEAN, INTEGER, LONG, FLOAT, DOUBLE, STRING, BOOLEAN_MAP, INTEGER_MAP, LONG_MAP,
                       FLOAT_MAP, DOUBLE_MAP, STRING_MAP, BOOLEAN_MAP_MAP, INTEGER_MAP_MAP, LONG_MAP_MAP,
                       FLOAT_MAP_MAP, DOUBLE_MAP_MAP, STRING_MAP_MAP, BOOLEAN_LIST, INTEGER_LIST, LONG_LIST,
                       FLOAT_LIST, DOUBLE_LIST, STRING_LIST, BOOLEAN_MAP_LIST, INTEGER_MAP_LIST, LONG_MAP_LIST,
                       FLOAT_MAP_LIST, DOUBLE_MAP_LIST, STRING_MAP_LIST"
              "description": "an optional description of this column",
              "subFields": [ include enumerated subfields (field must be of type MAP) of the form
                  {"name": "the name of the subfield", "description": "a description for it"}
              ]
              "subSubFields": [ include enumerated subSubfields (field must be of type MAP_MAP) of the form
                  {"name": "the name of the subsubfield", "description": "a description for it"}
              ]
              "subListFields": [ include enumerated subListfields (field must be of type MAP_LIST) of the form
                  {"name": "the name of the sublistfield", "description": "a description for it"}
              ]
         }
     }
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.gson.Gson	GSON
static String	VERSION_KEY

Constructor Summary

Constructors

Constructor and Description
SchemaService(String version, String filePath) Constructor that takes in a a string file path and a version string and loads the contents of the file.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

GSON

public static final com.google.gson.Gson GSON

VERSION_KEY

public static final String VERSION_KEY

See Also:

Constant Field Values

Constructor Detail

SchemaService

@Autowired
public SchemaService(@Value(value="${bullet.schema.version}")
                                String version,
                                @Value(value="${bullet.schema.file}")
                                String filePath)

Constructor that takes in a a string file path and a version string and loads the contents of the file. The file is expected to contain a JSON array with field entries.

Parameters:

version - The schema version.

filePath - The filePath to the file.