Struct graphannis::Graph

pub struct Graph { /* fields omitted */ }

A representation of a graph including node annotations and edges. Edges are partioned into components and each component is implemented by specialized graph storage implementation.

Use the CorpusStorage struct to create and manage instances of a Graph.

Graphs can have an optional location on the disk. In this case, changes to the graph via the apply_update(...) function are automatically persisted to this location.

Methods

impl Graph

pub fn get_graphstorage(&self, c: &Component) -> Option<Arc<GraphStorage>>

Get a read-only graph storage reference for the given component c.

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn get_all_components(     &self,     ctype: Option<ComponentType>,     name: Option<&str> ) -> Vec<Component>

Returns all components of the graph given an optional type (ctype) and name. This allows to filter which components to recieve. If you want to retrieve all components, use None as value for both arguments.

pub fn get_node_type_key(&self) -> AnnoKey

Return the annotation key which is used for the special annis::node_type annotation which every node must have to mark its existance.

Trait Implementations

impl MallocSizeOf for Graph

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl AnnotationStorage<NodeID> for Graph

Important traits for Vec<u8>

impl Write for Vec<u8>

fn get_annotations_for_item(&self, item: &NodeID) -> Vec<Annotation>

Get all annotations for an item (node or edge).

fn number_of_annotations(&self) -> usize

Return the total number of annotations contained in this AnnotationStorage.

fn number_of_annotations_by_name(     &self,     ns: Option<String>,     name: String ) -> usize

Return the number of annotations contained in this AnnotationStorage filtered by name and optional namespace (ns).

Important traits for Box<R>

impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn exact_anno_search<'a>(     &'a self,     namespace: Option<String>,     name: String,     value: Option<String> ) -> Box<Iterator<Item = Match> + 'a>

Returns an iterator for all items that exactly match the given annotation constraints. The annotation name must be given as argument, the other arguments are optional.

Important traits for Box<R>

impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn regex_anno_search<'a>(     &'a self,     namespace: Option<String>,     name: String,     pattern: &str ) -> Box<Iterator<Item = Match> + 'a>

Returns an iterator for all items where the value matches the regular expression. The annotation name and the pattern for the value must be given as argument, the namespace argument is optional and can be used as additional constraint.

fn guess_max_count(     &self,     ns: Option<String>,     name: String,     lower_val: &str,     upper_val: &str ) -> usize

Estimate the number of results for an annotation exact search for a given an inclusive value range.

fn guess_max_count_regex(     &self,     ns: Option<String>,     name: String,     pattern: &str ) -> usize

Estimate the number of results for an annotation regular expression search for a given pattern.

Important traits for Vec<u8>

impl Write for Vec<u8>

fn get_all_values(&self, key: &AnnoKey, most_frequent_first: bool) -> Vec<&str>

Return a list of all existing values for a given annotation key. If the most_frequent_firstparameter is true, the results are sorted by their frequency.

Important traits for Vec<u8>

impl Write for Vec<u8>

fn annotation_keys(&self) -> Vec<AnnoKey>

Get all the annotation keys which are part of this annotation storage