Uses of Class
nzilbb.util.ClonedProperty
-
Packages that use ClonedProperty Package Description nzilbb.ag Implementation of an Annotation Graph API for linguistic annotations.nzilbb.ag.automation.util Utility classes for helping processAnnotator
implementations.nzilbb.ag.serialize Contains interfaces that are required to convert too/from specific file formats.nzilbb.configure Object configuration formalization classes. -
-
Uses of ClonedProperty in nzilbb.ag
Methods in nzilbb.ag with annotations of type ClonedProperty Modifier and Type Method Description int
Layer. getAlignment()
Getter for alignment: The layer's alignment - 0 for none, 1 for point alignment, 2 for interval alignment.LinkedHashMap<String,Anchor>
Graph. getAnchors()
Getter for anchors: Map of anchors (graph nodes) keyed by id.String
TrackedMap. getAnnotator()
Getter forTrackedMap.annotator
: Name of the person or system that created or changed this entity.LinkedHashMap<String,String>
Schema. getCategories()
Getter forSchema.categories
: An ordered map of category names to descriptions.String
Layer. getCategory()
Getter forLayer.category
: Category for the layer, if any.Integer
TrackedMap. getConfidence()
Getter forTrackedMap.confidence
: Confidence rating.String
Schema. getCorpusLayerId()
Getter forSchema.corpusLayerId
: ID of the layer that tags the graph with its corpus name, if any.String
Layer. getDescription()
Getter for description: The description of the layer.String
MediaTrackDefinition. getDescription()
Getter forMediaTrackDefinition.description
: The description of the track.String
Annotation. getEndId()
Getter for endId: ID of the annotation's end anchor.String
Schema. getEpisodeLayerId()
Getter forSchema.episodeLayerId
: ID of the layer that tags the graph with its episode name, if any.String
MediaFile. getExtension()
The file's extension, not including the dot.MediaFile
MediaFile. getGenerateFrom()
Getter forMediaFile.generateFrom
: The media file from which this one could be generated, or null if the file already exists.String
TrackedMap. getId()
Getter for id: The object's identifier.String
Annotation. getLabel()
Getter for label: The annotation's label.String
Annotation. getLayerId()
Getter for layerId: The identifier of the annotation's layer.LinkedHashMap<String,Layer>
Schema. getLayers()
Getter forSchema.layers
: Layers, indexed by ID.String
MediaFile. getMimeType()
Getter forMediaFile.mimeType
: The MIME type of the file.String
MediaFile. getName()
Getter forMediaFile.name
: Name of the fileString
MediaFile. getNameWithoutSuffix()
Strip of the existension of the file name.Double
Anchor. getOffset()
Getter for offset: The anchor's time/character offset.int
Annotation. getOrdinal()
Getter for ordinal: The annotation's ordinal position amongst the parent's children.String
Annotation. getParentId()
Getter for parentId: The annotation's parent annotation ID, if any.String
Layer. getParentId()
Getter for parentId: The layer's parent layer id.boolean
Layer. getParentIncludes()
Getter for parentIncludes: Whether the parent t-includes the child.String
Schema. getParticipantLayerId()
Getter forSchema.participantLayerId
: ID of the layer that contains participants.boolean
Layer. getPeers()
Getter for peers: Whether children on this layer have peers or not.boolean
Layer. getPeersOverlap()
Getter for peersOverlap: Whether child peers can overlap or not.Layer
Schema. getRoot()
Getter forSchema.root
: The root of the layer hierarchy, representing the graph as a whole.boolean
Layer. getSaturated()
Getter for saturated: Whether children on this layer must temporally fill the entire parent duration (true) or not (false).Schema
Graph. getSchema()
Getter forGraph.schema
: The layer definitions and their interrelations.String
Annotation. getStartId()
Getter for startId: ID of the annotation's start anchor.String
MediaTrackDefinition. getSuffix()
Getter forMediaTrackDefinition.suffix
: The file suffix associated with the track.String
MediaFile. getTrackSuffix()
Getter forMediaFile.trackSuffix
: The track suffix of the media - seeMediaTrackDefinition.suffix
.String
Schema. getTurnLayerId()
Getter forSchema.turnLayerId
: ID of the layer that contains speaker turns.String
Layer. getType()
Getter forLayer.type
: The type for labels on this layer.String
MediaFile. getType()
Gets the media type of the file.String
MediaFile. getUrl()
Getter forMediaFile.url
: URL to the content of the file.String
Schema. getUtteranceLayerId()
Getter forSchema.utteranceLayerId
: ID of the layer that contains speaker utterances.LinkedHashMap<String,String>
Layer. getValidLabels()
Getter for validLabels: List of valid label values for this layer, or null if the layer values are not restricted.Date
TrackedMap. getWhen()
Getter forTrackedMap.when
: Date/time this entity was created or changed.String
Schema. getWordLayerId()
Getter forSchema.wordLayerId
: ID of the layer that contains individual word tokens. -
Uses of ClonedProperty in nzilbb.ag.automation.util
Methods in nzilbb.ag.automation.util with annotations of type ClonedProperty Modifier and Type Method Description String
AnnotatorDescriptor. getAnnotatorId()
Unique name for the annotator, which is immutable across versions of the implemetantation.String
AnnotatorDescriptor. getConfigParameterInfo()
Retrieves HTML-encoded definition of the installation config parameters, including a list of all parameters, and the encoding of the parameter string, for displaying to users who wish to configure the annotator programmatically.String
AnnotatorDescriptor. getExtApiInfo()
Retrieves HTML-encoded document containing information about what endpoints are published by the ext web-app, for displaying to users who wish to use it programmatically.Boolean
AnnotatorDescriptor. getHasConfigWebapp()
Bean-getter version ofAnnotatorDescriptor.hasConfigWebapp()
Boolean
AnnotatorDescriptor. getHasExtWebapp()
Bean-getter version ofAnnotatorDescriptor.hasExtWebapp()
Boolean
AnnotatorDescriptor. getHasTaskWebapp()
Bean-getter version ofAnnotatorDescriptor.hasTaskWebapp()
String
AnnotatorDescriptor. getInfo()
Retrieves HTML-encoded description of the function of the annotator, for displaying to the user.String
AnnotatorDescriptor. getMinimumApiVersion()
Get the minimum version of the nzilbb.ag API supported by the serializer.String
AnnotatorDescriptor. getTaskParameterInfo()
Retrieves HTML-encoded definition of the task parameters, including a list of all parameters, and the encoding of the parameter string, for displaying to users who wish to configure annotator tasks programmatically.String
AnnotatorDescriptor. getVersion()
Version of this implementation; versions will typically be numeric, but this is not a requirement. -
Uses of ClonedProperty in nzilbb.ag.serialize
Methods in nzilbb.ag.serialize with annotations of type ClonedProperty Modifier and Type Method Description Vector<String>
SerializationDescriptor. getFileSuffixes()
Getter forSerializationDescriptor.fileSuffixes
: The normal file name suffixes (extensions) of this MIME type.URL
SerializationDescriptor. getIcon()
Getter forSerializationDescriptor.icon
: URL to an icon for this MIME type.String
SerializationDescriptor. getMimeType()
Getter forSerializationDescriptor.mimeType
: The MIME type of the format.String
SerializationDescriptor. getMinimumApiVersion()
Getter forSerializationDescriptor.minimumApiVersion
: Minimum version of the nzilbb.ag API supported by the serializer.String
SerializationDescriptor. getName()
Getter forSerializationDescriptor.name
: The name of the format or storage system that is used for serialization/deserialization.int
SerializationDescriptor. getNumberOfInputs()
Getter forSerializationDescriptor.numberOfInputs
: The (maximum) number of inputs required - e.g. the number of annotation files that make up a graph.String
SerializationDescriptor. getVersion()
Getter forSerializationDescriptor.version
: The version of the serializer/deserializer. -
Uses of ClonedProperty in nzilbb.configure
Methods in nzilbb.configure with annotations of type ClonedProperty Modifier and Type Method Description String
Parameter. getHint()
Getter forParameter.hint
: A text hint that might be displayed to a user.String
Parameter. getLabel()
Getter forParameter.label
: A label that might be presented to a user.String
Parameter. getName()
Getter forParameter.name
: The paramater's name.boolean
Parameter. getRequired()
Getter forParameter.required
: Whether the parameter is required (true) or optional (false - the default).Class
Parameter. getType()
Getter forParameter.type
: The type of the parameter.
-