public interface ExtensionScheme extends MetadataObject, WeakReferenceTarget
Groups together a collection of meta definitions for an extension to a file and provides a globally unique identifier for the collection.
An MXF file may contain any number of Extension Scheme objects.
An extension scheme may be used as part of an application metadata plugin or descriptive framework.
| Modifier and Type | Method and Description |
|---|---|
void |
addMetaDefinition(MetaDefinition metaDefinition)
Add a meta definition to the set of definitions that form this extension
scheme.
|
void |
clearMetaDefinitions()
Clear all the meta definitions from this extensions scheme, omitting this optional property.
|
ExtensionScheme |
clone()
Create a cloned copy of this extension scheme.
|
boolean |
containsMetaDefinition(AUID metaDefinitionID)
Determines whether the given identifier is for a meta definition that is present
within those that make up this extension scheme.
|
boolean |
containsMetaDefinition(MetaDefinition metaDefinition)
Determines whether the given meta definition is present within those that make up this
extension scheme.
|
boolean |
containsMetaDefinition(String metaDefinitionName)
Determines whether the given name is for a meta definition that is present
within those that make up this extension scheme.
|
int |
countMetaDefinitions()
Count the number of meta definitions in this extensions scheme.
|
String |
getExtensionDescription()
Returns the description of the extension scheme.
|
Set<MetaDefinition> |
getMetaDefinitions()
Returns the set of meta definitions that form the extensions scheme.
|
String |
getPreferredPrefix()
Returns the preferred namespace tag when SMPTE Reg-XML encoding is used.
|
AUID |
getSchemeID()
Returns the globally unique identification of the extension scheme.
|
String |
getSchemeURI()
Returns the namespace URI for the extension scheme.
|
MetaDefinition |
lookupMetaDefinition(AUID metaDefinitionID)
Lookup a meta definition within this extension scheme by its identifier.
|
MetaDefinition |
lookupMetaDefinition(String metaDefinitionName)
Lookup a meta definition within this extension scheme by its name.
|
AUID |
lookupMetaDefinitionIdentifier(String metaDefinitionName)
Lookup the identifier of a meta definition in this extension scheme from
its name.
|
boolean |
removeMetaDefinition(AUID metaDefinitionID)
Remove the identified meta definition from those that make up this
extension scheme.
|
boolean |
removeMetaDefinition(MetaDefinition metaDefinition)
Remove the given meta definition from those that make up this
extension scheme.
|
void |
setExtensionDescription(String extensionDescription)
Sets the description of the extension scheme.
|
void |
setPreferredPrefix(String preferredPrefix)
Sets the preferred namespace tag when SMPTE Reg-XML encoding is used.
|
void |
setSchemeID(AUID schemeID)
Sets the globally unique identification of the extensions scheme.
|
void |
setSchemeURI(String schemeURI)
Sets the namespace URI for the extension scheme.
|
getAUID, getWeakTargetReferenceAUID getSchemeID()
Returns the globally unique identification of the extension scheme.
getSchemeURI(),
ApplicationPluginObject.getApplicationScheme(),
Preface.getApplicationSchemes(),
Preface.getDescriptiveSchemes()void setSchemeID(AUID schemeID) throws NullPointerException
Sets the globally unique identification of the extensions scheme. An extension scheme may be used as part of an application metadata plugin or descriptive framework.
schemeID - Globally unique identification of the extensions scheme.NullPointerException - Cannot set the scheme identifier using a null
value.setSchemeURI(String),
tv.amwa.maj.model.ApplicationPluginObject#setApplicationScheme(AUID),
Preface.getApplicationSchemes(),
Preface.getDescriptiveSchemes()String getSchemeURI()
Returns the namespace URI for the extension scheme.
getSchemeID(),
MetaDefinition.getNamespace(),
MediaClass.namespace(),
MediaProperty.namespace()void setSchemeURI(String schemeURI) throws NullPointerException
Sets the namespace URI for the extension scheme.
schemeURI - Namespace URI for the extension scheme.NullPointerException - Cannot set the scheme identifier using a null
value.setSchemeID(AUID),
MetaDefinition.setNamespace(String),
MediaClass.namespace(),
MediaProperty.namespace()String getPreferredPrefix() throws PropertyNotPresentException
Returns the preferred namespace tag when SMPTE Reg-XML encoding is used. This is an optional property.
PropertyNotPresentException - The optional preferred prefix property is
not present for this extension scheme.getSchemeURI(),
MetaDefinition.getPrefix(),
MediaClass.prefix(),
MediaProperty.prefix()void setPreferredPrefix(String preferredPrefix)
Sets the preferred namespace tag when SMPTE Reg-XML encoding is used. Set this optional
property to null to omit it.
preferredPrefix - Preferred namespace tag when SMPTE Reg-XML encoding is used.setSchemeURI(String),
MediaClass.prefix(),
MediaProperty.prefix()String getExtensionDescription() throws PropertyNotPresentException
Returns the description of the extension scheme. This is an optional property.
PropertyNotPresentException - The optional description property of the extension scheme is
not present.void setExtensionDescription(String extensionDescription)
Sets the description of the extension scheme. Set this optional property to null
to omit it.
extensionDescription - Description of the extension scheme.Set<MetaDefinition> getMetaDefinitions() throws PropertyNotPresentException
Returns the set of meta definitions that form the extensions scheme. The meta definitions are the class definitions, property definitions and type definitions that define extensions classes and properties for use in:
This is an optional property, although omitting it and defining an empty scheme would not make much sense.
PropertyNotPresentException - The optional meta definitions property is not present for this
extension scheme.void addMetaDefinition(MetaDefinition metaDefinition) throws NullPointerException
Add a meta definition to the set of definitions that form this extension scheme.
metaDefinition - Meta definition to add to the scheme.NullPointerException - Cannot use a null value to add to the set of meta
definitions.getMetaDefinitions()MetaDefinition lookupMetaDefinition(AUID metaDefinitionID) throws NullPointerException
Lookup a meta definition within this extension scheme by its identifier.
metaDefinitionID - Identifier of the meta definition to find in the extension scheme.null if no matching meta definition could be
found.NullPointerException - Cannot look for a meta definition using a null value.lookupMetaDefinition(String),
lookupMetaDefinitionIdentifier(String),
getMetaDefinitions()MetaDefinition lookupMetaDefinition(String metaDefinitionName) throws NullPointerException
Lookup a meta definition within this extension scheme by its name.
metaDefinitionName - Name of the meta definition to find in the extension scheme.null if no matching meta definition could be
found.NullPointerException - Cannot look for a meta definition using a null value.lookupMetaDefinition(AUID),
lookupMetaDefinitionIdentifier(String),
getMetaDefinitions()AUID lookupMetaDefinitionIdentifier(String metaDefinitionName) throws NullPointerException
Lookup the identifier of a meta definition in this extension scheme from its name.
metaDefinitionName - Name of the meta definition to find in the extension scheme.NullPointerException - Cannot look for a meta definition using a null value.lookupMetaDefinition(AUID),
lookupMetaDefinition(String),
getMetaDefinitions()boolean containsMetaDefinition(MetaDefinition metaDefinition) throws NullPointerException
Determines whether the given meta definition is present within those that make up this extension scheme.
metaDefinition - Meta definition to check for.NullPointerException - Cannot use a null value to check for a meta definition.containsMetaDefinition(AUID),
containsMetaDefinition(String),
getMetaDefinitions()boolean containsMetaDefinition(AUID metaDefinitionID) throws NullPointerException
Determines whether the given identifier is for a meta definition that is present within those that make up this extension scheme.
metaDefinition - Identifier of the meta definition to check for.NullPointerException - Cannot use a null value to check for a meta definition.containsMetaDefinition(MetaDefinition),
containsMetaDefinition(String),
getMetaDefinitions()boolean containsMetaDefinition(String metaDefinitionName) throws NullPointerException
Determines whether the given name is for a meta definition that is present within those that make up this extension scheme.
metaDefinition - Name of the meta definition to check for.NullPointerException - Cannot use a null value to check for a meta definition.containsMetaDefinition(MetaDefinition),
containsMetaDefinition(AUID),
getMetaDefinitions()void clearMetaDefinitions()
Clear all the meta definitions from this extensions scheme, omitting this optional property.
getMetaDefinitions()int countMetaDefinitions()
Count the number of meta definitions in this extensions scheme.
getMetaDefinitions()boolean removeMetaDefinition(MetaDefinition metaDefinition) throws NullPointerException
Remove the given meta definition from those that make up this extension scheme.
metaDefinition - Meta definition to remove.false if
the meta definition was not part of this extension scheme.NullPointerException - Cannot remove a meta definition using a null value.removeMetaDefinition(AUID),
getMetaDefinitions()boolean removeMetaDefinition(AUID metaDefinitionID) throws NullPointerException
Remove the identified meta definition from those that make up this extension scheme.
metaDefinition - Identifier of the meta definition to remove.false if
the meta definition was not part of this extension scheme.NullPointerException - Cannot remove a meta definition using a null value.removeMetaDefinition(MetaDefinition),
getMetaDefinitions()ExtensionScheme clone()
Create a cloned copy of this extension scheme.
(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.