Package org.radarbase.schema.specification

Class DataTopic

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDoc()  
      java.util.List<AppDataTopic.DataField> getFields()  
      SampleRateConfig getSampleRate()  
      java.util.stream.Stream<java.lang.String> getTopicNames()
      Get all topic names that are provided by the data.
      java.util.stream.Stream<org.radarbase.topic.AvroTopic<?,​?>> getTopics​(SchemaCatalogue schemaCatalogue)
      Get all Avro topics that are provided by the data.
      java.lang.String getType()  
      org.radarcns.catalogue.Unit getUnit()  
      protected void propertiesMap​(java.util.Map<java.lang.String,​java.lang.Object> map, boolean reduced)
      Turns this topic into an descriptive properties map.
      void setKeySchema​(java.lang.String schema)  
      void setValueSchema​(java.lang.String schema)  
      java.lang.String toString()  
      java.lang.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 Detail

      • DataTopic

        public DataTopic()
        DataTopic using ObservationKey as the default key.

    • Method Detail

      • getTopicNames

        public java.util.stream.Stream<java.lang.String> getTopicNames()
        Get all topic names that are provided by the data.

      • getTopics

        public java.util.stream.Stream<org.radarbase.topic.AvroTopic<?,​?>> getTopics​(SchemaCatalogue schemaCatalogue)
                                                                            throws java.io.IOException
        Get all Avro topics that are provided by the data.
        Throws:
        java.io.IOException

      • getType

        public java.lang.String getType()

      • getDoc

        public java.lang.String getDoc()

      • getUnit

        public org.radarcns.catalogue.Unit getUnit()

      • setKeySchema

        public void setKeySchema​(java.lang.String schema)
        Overrides:
        setKeySchema in class org.radarbase.config.AvroTopicConfig

      • setValueSchema

        public void setValueSchema​(java.lang.String schema)
        Overrides:
        setValueSchema in class org.radarbase.config.AvroTopicConfig

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • toString

        public java.lang.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​(java.util.Map<java.lang.String,​java.lang.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.