Package org.radarbase.schema.specification

Class DataTopic

java.lang.Object

org.radarbase.config.AvroTopicConfig

org.radarbase.schema.specification.DataTopic

Direct Known Subclasses:

AppDataTopic, QuestionnaireDataTopic, StreamDataTopic

public class DataTopic
extends org.radarbase.config.AvroTopicConfig

DataTopic topic from a data producer.

Constructor Summary

Constructors

Constructor	Description
DataTopic()	DataTopic using ObservationKey as the default key.

Method Summary

Modifier and Type	Method	Description
String	getDoc()
List<AppDataTopic.DataField>	getFields()
SampleRateConfig	getSampleRate()
Stream<String>	getTopicNames()	Get all topic names that are provided by the data.
Stream<org.radarbase.topic.AvroTopic<?,?>>	getTopics(SchemaCatalogue schemaCatalogue)	Get all Avro topics that are provided by the data.
String	getType()
org.radarcns.catalogue.Unit	getUnit()
protected void	propertiesMap(Map<String,Object> map, boolean reduced)	Turns this topic into an descriptive properties map.
void	setKeySchema(String schema)
void	setValueSchema(String schema)
String	toString()
String	toString(boolean prettyString)	Convert the topic to String, either as dense string or as verbose YAML string.

Methods inherited from class org.radarbase.config.AvroTopicConfig

getKeySchema, getTags, getTopic, getValueSchema, parseAvroTopic, setTags, setTopic

Methods inherited from class java.lang.Object

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

Constructor Details

DataTopic

public DataTopic()

DataTopic using ObservationKey as the default key.

Method Details

getTopicNames

public Stream<String> getTopicNames()

Get all topic names that are provided by the data.

getTopics

public Stream<org.radarbase.topic.AvroTopic<?,?>> getTopics(SchemaCatalogue schemaCatalogue)
                                                     throws IOException

Get all Avro topics that are provided by the data.

Throws:

IOException

getType

public String getType()

getDoc

public String getDoc()

getSampleRate

public SampleRateConfig getSampleRate()

getUnit

public org.radarcns.catalogue.Unit getUnit()

getFields

public List<AppDataTopic.DataField> getFields()

setKeySchema

public void setKeySchema(String schema)

Overrides:

setKeySchema in class org.radarbase.config.AvroTopicConfig

setValueSchema

public void setValueSchema(String schema)

Overrides:

setValueSchema in class org.radarbase.config.AvroTopicConfig

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean prettyString)

Convert the topic to String, either as dense string or as verbose YAML string.

Parameters:

prettyString - Whether the result should be a verbose pretty-printed string.

Returns:

topic as a string.

propertiesMap

protected void propertiesMap(Map<String,Object> map,
 boolean reduced)

Turns this topic into an descriptive properties map.

Parameters:

map - properties to add to.

reduced - whether to set a reduced set of properties, to decrease verbosity.