Struct stam::AnnotationStoreBuilder

pub struct AnnotationStoreBuilder<'a> { /* private fields */ }

Implementations

impl<'a> AnnotationStoreBuilder<'a>

pub fn new() -> Self

Start a new AnnotationStoreBuilder to build an AnnotationStore. Chain various with_*() methods and call build() in the end fo produce the actual AnnotationStore.

pub fn with_id(self, id: String) -> Self

Set the public ID for the AnnotationStore that will be built.

pub fn with_annotationset( self, annotationset: AnnotationDataSetBuilder<'a> ) -> Self

Add an AnnotationDataSet to the store (in the form of a builder). Can be called multiple times.

pub fn with_annotationsets( self, annotationsets: Vec<AnnotationDataSetBuilder<'a>> ) -> Self

Adds multiple annotation sets at once, this can only be called once as it will overwrite existing builders.

pub fn with_resource(self, resource: TextResourceBuilder) -> Self

Add an TextResource to the store (in the form of a builder). Can be called multiple times.

pub fn with_resources(self, resources: Vec<TextResourceBuilder>) -> Self

Adds multiple resource builders at once, this can only be called once as it will overwrite existing builders.

pub fn with_annotation(self, annotation: AnnotationBuilder<'a>) -> Self

Adds an annotation builder, can be called multiple times.

pub fn with_annotations(self, annotations: Vec<AnnotationBuilder<'a>>) -> Self

Adds multiple annotation builders, this can only be called once as it will overwrite existing annotation builders.

pub fn with_filename(self, filename: &str) -> Self

Set the filename for the AnnotationStore that will be built. This does not load from file. Use AnnotationStore::from_file() instead of this builder if that’s what you want.

pub fn with_config(self, config: Config) -> Self

pub fn build(self) -> Result<AnnotationStore, StamError>

Builds a new annotation store from [`AnnotationStoreBuilder’].

Trait Implementations

impl<'a> Default for AnnotationStoreBuilder<'a>

fn default() -> AnnotationStoreBuilder<'a>

Returns the “default value” for a type.

impl<'de, 'a> Deserialize<'de> for AnnotationStoreBuilder<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'c, 'a> FromCsv<'c> for AnnotationStoreBuilder<'a>

fn from_csv_reader( reader: Box<dyn BufRead>, filename: Option<&str>, config: Config ) -> Result<Self, StamError>

fn from_csv_file(filename: &str, config: Config) -> Result<Self, StamError>

impl<'j, 'a> FromJson<'j> for AnnotationStoreBuilder<'a>

fn from_json_file(filename: &str, config: Config) -> Result<Self, StamError>

Loads an AnnotationStore from a STAM JSON file The file must contain a single object which has “@type”: “AnnotationStore”

fn from_json_str(string: &str, config: Config) -> Result<Self, StamError>

Loads an AnnotationStore from a STAM JSON string The string must contain a single object which has “@type”: “AnnotationStore”

impl<'a> TryFrom<AnnotationStoreBuilder<'a>> for AnnotationStore

type Error = StamError

The type returned in the event of a conversion error.

fn try_from(builder: AnnotationStoreBuilder<'_>) -> Result<Self, StamError>

Performs the conversion.

impl<'a> TypeInfo for AnnotationStoreBuilder<'a>

fn typeinfo() -> Type