CvContainer (ARCTokenization)

CvContainer Type

Namespace: ControlledVocabulary
Assembly: ControlledVocabulary.dll
Base Type: CvAttributeCollection
All Interfaces: IDictionary<string, IParam> , ICollection<KeyValuePair<string, IParam>> , IReadOnlyDictionary<string, IParam> , IReadOnlyCollection<KeyValuePair<string, IParam>> , IEnumerable<KeyValuePair<string, IParam>> , IDictionary , ICollection , IEnumerable , IDeserializationCallback , ISerializable , ICvBase , IAttributeCollection

Represents a collection of structured properties, annotated with a controlled vocabulary term.

Constructors

Constructor	Description
`CvContainer(term)` Full Usage: `CvContainer(term)` Parameters: term : `CvTerm` Returns: `CvContainer`	term : `CvTerm` Returns: `CvContainer`
`CvContainer(term, attributes)` Full Usage: `CvContainer(term, attributes)` Parameters: term : `CvTerm` attributes : `IParam seq` Returns: `CvContainer`	term : `CvTerm` attributes : `IParam seq` Returns: `CvContainer`
`CvContainer(term, attributes)` Full Usage: `CvContainer(term, attributes)` Parameters: term : `CvTerm` attributes : `IDictionary<string, IParam>` Returns: `CvContainer`	term : `CvTerm` attributes : `IDictionary<string, IParam>` Returns: `CvContainer`
`CvContainer(cvAccession, cvName, cvRefUri)` Full Usage: `CvContainer(cvAccession, cvName, cvRefUri)` Parameters: cvAccession : `string` cvName : `string` cvRefUri : `string` Returns: `CvContainer`	cvAccession : `string` cvName : `string` cvRefUri : `string` Returns: `CvContainer`
`CvContainer(cvAccession, cvName, cvRefUri, attributes)` Full Usage: `CvContainer(cvAccession, cvName, cvRefUri, attributes)` Parameters: cvAccession : `string` cvName : `string` cvRefUri : `string` attributes : `IParam seq` Returns: `CvContainer`	cvAccession : `string` cvName : `string` cvRefUri : `string` attributes : `IParam seq` Returns: `CvContainer`
`CvContainer(cvAccession, cvName, cvRefUri, attributes)` Full Usage: `CvContainer(cvAccession, cvName, cvRefUri, attributes)` Parameters: cvAccession : `string` cvName : `string` cvRefUri : `string` attributes : `IDictionary<string, IParam>` Returns: `CvContainer`	cvAccession : `string` cvName : `string` cvRefUri : `string` attributes : `IDictionary<string, IParam>` Returns: `CvContainer`
`CvContainer(cvAccession, cvName, cvRef, attributes, properties)` Full Usage: `CvContainer(cvAccession, cvName, cvRef, attributes, properties)` Parameters: cvAccession : `string` cvName : `string` cvRef : `string` attributes : `IDictionary<string, IParam>` properties : `IDictionary<string, ICvBase seq>` Returns: `CvContainer`	cvAccession : `string` cvName : `string` cvRef : `string` attributes : `IDictionary<string, IParam>` properties : `IDictionary<string, ICvBase seq>` Returns: `CvContainer`

Instance members

Instance member	Description
`this.ContainsProperty` Full Usage: `this.ContainsProperty` Parameters: propertyName : `string` Returns: `bool`	propertyName : `string` Returns: `bool`
`this.CountChildren` Full Usage: `this.CountChildren` Returns: `int`	Returns: `int`
`this.CountProperties` Full Usage: `this.CountProperties` Returns: `int`	Returns: `int`
`this.GetMany` Full Usage: `this.GetMany` Parameters: propertyName : `string` Returns: `ICvBase seq`	Retrieves children with the given name of the CvContainer as sequence. Fails if the propertyName cannot be found. propertyName : `string` Returns: `ICvBase seq`
`this.GetManyAs` Full Usage: `this.GetManyAs` Parameters: propertyName : `string` Returns: `'T seq` Modifiers: inline Type parameters: 'T	Retrieves children with the given name and which can be cast to the given type of the CvContainer as sequence. Fails if the propertyName cannot be found. propertyName : `string` Returns: `'T seq`
`this.GetManyContainers` Full Usage: `this.GetManyContainers` Parameters: propertyName : `string` Returns: `CvContainer seq`	Retrieves CvContainer children with the given name of the CvContainer as sequence. Fails if the propertyName cannot be found. propertyName : `string` Returns: `CvContainer seq`
`this.GetManyParams` Full Usage: `this.GetManyParams` Parameters: propertyName : `string` Returns: `IParam seq`	Retrieves Param children with the given name of the CvContainer as sequence. Fails if the propertyName cannot be found. propertyName : `string` Returns: `IParam seq`
`this.GetSingle` Full Usage: `this.GetSingle` Parameters: propertyName : `string` Returns: `ICvBase`	Retrieves child with the given name of the CvContainer. Fails if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` Returns: `ICvBase`
`this.GetSingleAs` Full Usage: `this.GetSingleAs` Parameters: propertyName : `string` Returns: `'T` Modifiers: inline Type parameters: 'T	Retrieves child with the given name and which can be cast to the given type of the CvContainer. Fails if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` Returns: `'T`
`this.GetSingleContainer` Full Usage: `this.GetSingleContainer` Parameters: propertyName : `string` Returns: `CvContainer`	Retrieves CvContainer child with the given name of the CvContainer. Fails if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` Returns: `CvContainer`
`this.GetSingleParam` Full Usage: `this.GetSingleParam` Parameters: propertyName : `string` Returns: `IParam`	Retrieves Param child with the given name of the CvContainer. Fails if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` Returns: `IParam`
`this.Properties` Full Usage: `this.Properties` Returns: `IDictionary<string, ICvBase seq>`	Returns: `IDictionary<string, ICvBase seq>`
`this.TryGetMany` Full Usage: `this.TryGetMany` Parameters: propertyName : `string` Returns: `ICvBase seq option`	Retrieves children with the given name of the CvContainer as sequence. Returns None if the propertyName cannot be found. propertyName : `string` Returns: `ICvBase seq option`
`this.TryGetManyAs` Full Usage: `this.TryGetManyAs` Parameters: propertyName : `string` Returns: `'T seq option` Modifiers: inline Type parameters: 'T	Retrieves children with the given name and which can be cast to the given type of the CvContainer as sequence. Returns None if the propertyName cannot be found. propertyName : `string` Returns: `'T seq option`
`this.TryGetManyContainers` Full Usage: `this.TryGetManyContainers` Parameters: propertyName : `string` Returns: `CvContainer seq option`	Retrieves CvContainer children with the given name of the CvContainer as sequence. Returns None if the propertyName cannot be found. propertyName : `string` Returns: `CvContainer seq option`
`this.TryGetManyParams` Full Usage: `this.TryGetManyParams` Parameters: propertyName : `string` Returns: `IParam seq option`	Retrieves Param children with the given name of the CvContainer as sequence. Returns None if the propertyName cannot be found. propertyName : `string` Returns: `IParam seq option`
`this.TryGetSingle` Full Usage: `this.TryGetSingle` Parameters: propertyName : `string` Returns: `ICvBase option`	Retrieves child with the given name of the CvContainer. Returns None if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` Returns: `ICvBase option`
`this.TryGetSingleAs` Full Usage: `this.TryGetSingleAs` Parameters: propertyName : `string` Returns: `'T option` Modifiers: inline Type parameters: 'T	Retrieves child with the given name and which can be cast to the given type of the CvContainer. Returns None if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` Returns: `'T option`
`this.TryGetSingleContainer` Full Usage: `this.TryGetSingleContainer` Parameters: propertyName : `string` Returns: `CvContainer option`	Retrieves CvContainer child with the given name of the CvContainer. Returns None if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` Returns: `CvContainer option`
`this.TryGetSingleParam` Full Usage: `this.TryGetSingleParam` Parameters: propertyName : `string` Returns: `IParam option`	Retrieves Param child with the given name of the CvContainer. Returns None if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` Returns: `IParam option`

Static members

Static member	Description
`CvContainer.addMany values cvContainer` Full Usage: `CvContainer.addMany values cvContainer` Parameters: values : `ICvBase seq` cvContainer : `CvContainer`	Adds children as a property of the CvContainer. If values with the same key already exist in the container, appends the new child values : `ICvBase seq` cvContainer : `CvContainer`
`CvContainer.addSingle value cvContainer` Full Usage: `CvContainer.addSingle value cvContainer` Parameters: value : `ICvBase` cvContainer : `CvContainer`	Adds a child as a property of the CvContainer. If a value with the same key already exist in the container, appends the new child value : `ICvBase` cvContainer : `CvContainer`
`CvContainer.containsProperty propertyName container` Full Usage: `CvContainer.containsProperty propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `bool`	propertyName : `string` container : `CvContainer` Returns: `bool`
`CvContainer.countChildren container` Full Usage: `CvContainer.countChildren container` Parameters: container : `CvContainer` Returns: `int`	container : `CvContainer` Returns: `int`
`CvContainer.countProperties container` Full Usage: `CvContainer.countProperties container` Parameters: container : `CvContainer` Returns: `int`	container : `CvContainer` Returns: `int`
`CvContainer.getMany propertyName container` Full Usage: `CvContainer.getMany propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `ICvBase seq`	Retrieves children with the given name of the CvContainer as sequence. Fails if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `ICvBase seq`
`CvContainer.getManyAs propertyName container` Full Usage: `CvContainer.getManyAs propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `'T seq` Modifiers: inline Type parameters: 'T	Retrieves children with the given name and which can be cast to the given type of the CvContainer as sequence. Fails if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `'T seq`
`CvContainer.getManyContainers propertyName container` Full Usage: `CvContainer.getManyContainers propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `CvContainer seq`	Retrieves CvContainer children with the given name of the CvContainer as sequence. Fails if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `CvContainer seq`
`CvContainer.getManyParams propertyName container` Full Usage: `CvContainer.getManyParams propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `IParam seq`	Retrieves Param children with the given name of the CvContainer as sequence. Fails if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `IParam seq`
`CvContainer.getSingle propertyName container` Full Usage: `CvContainer.getSingle propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `ICvBase`	Retrieves child with the given name of the CvContainer. Fails if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `ICvBase`
`CvContainer.getSingleAs propertyName container` Full Usage: `CvContainer.getSingleAs propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `'T` Modifiers: inline Type parameters: 'T	Retrieves child with the given name and which can be cast to the given type of the CvContainer. Fails if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `'T`
`CvContainer.getSingleContainer propertyName container` Full Usage: `CvContainer.getSingleContainer propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `CvContainer`	Retrieves CvContainer child with the given name of the CvContainer. Fails if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `CvContainer`
`CvContainer.getSingleParam propertyName container` Full Usage: `CvContainer.getSingleParam propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `IParam`	Retrieves Param child with the given name of the CvContainer. Fails if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `IParam`
`CvContainer.setMany values cvContainer` Full Usage: `CvContainer.setMany values cvContainer` Parameters: values : `ICvBase seq` cvContainer : `CvContainer`	Sets children as a property of the CvContainer. These children are supposed to all have the same name, as they will be grouped into one property of the container, accessible by this shared name. Fails if values has elements with different names. values : `ICvBase seq` cvContainer : `CvContainer`
`CvContainer.setSingle value cvContainer` Full Usage: `CvContainer.setSingle value cvContainer` Parameters: value : `ICvBase` cvContainer : `CvContainer` Returns: `IDictionary<string, ICvBase seq>`	Sets a single child as a property of the CvContainer, accessible by its name. value : `ICvBase` cvContainer : `CvContainer` Returns: `IDictionary<string, ICvBase seq>`
`CvContainer.tryCvContainer cv` Full Usage: `CvContainer.tryCvContainer cv` Parameters: cv : `ICvBase` Returns: `CvContainer option`	Returns Some CvContainer, if the given cv item can be downcast, else returns None cv : `ICvBase` Returns: `CvContainer option`
`CvContainer.tryGetMany propertyName container` Full Usage: `CvContainer.tryGetMany propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `ICvBase seq option`	Retrieves children with the given name of the CvContainer as sequence. Returns None if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `ICvBase seq option`
`CvContainer.tryGetManyAs propertyName container` Full Usage: `CvContainer.tryGetManyAs propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `'T seq option` Modifiers: inline Type parameters: 'T	Retrieves children with the given name and which can be cast to the given type of the CvContainer as sequence. Returns None if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `'T seq option`
`CvContainer.tryGetManyContainers propertyName container` Full Usage: `CvContainer.tryGetManyContainers propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `CvContainer seq option`	Retrieves CvContainer children with the given name of the CvContainer as sequence. Returns None if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `CvContainer seq option`
`CvContainer.tryGetManyParams propertyName container` Full Usage: `CvContainer.tryGetManyParams propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `IParam seq option`	Retrieves Param children with the given name of the CvContainer as sequence. Returns None if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `IParam seq option`
`CvContainer.tryGetSingle propertyName container` Full Usage: `CvContainer.tryGetSingle propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `ICvBase option`	Retrieves child with the given name of the CvContainer. Returns None if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `ICvBase option`
`CvContainer.tryGetSingleAs propertyName container` Full Usage: `CvContainer.tryGetSingleAs propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `'T option` Modifiers: inline Type parameters: 'T	Retrieves child with the given name and which can be cast to the given type of the CvContainer. Returns None if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `'T option`
`CvContainer.tryGetSingleContainer propertyName container` Full Usage: `CvContainer.tryGetSingleContainer propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `CvContainer option`	Retrieves CvContainer child with the given name of the CvContainer. Returns None if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `CvContainer option`
`CvContainer.tryGetSingleParam propertyName container` Full Usage: `CvContainer.tryGetSingleParam propertyName container` Parameters: propertyName : `string` container : `CvContainer` Returns: `IParam option`	Retrieves Param child with the given name of the CvContainer. Returns None if there is not exactly one child with the given name or if the propertyName cannot be found. propertyName : `string` container : `CvContainer` Returns: `IParam option`