public interface Root extends MetadataObject
Represents the logical association of the definitions of the extensions used in a file with the structural and descriptive metadata in the file.
ExtensionScheme,
Preface| Modifier and Type | Method and Description |
|---|---|
void |
addRootExtension(ExtensionScheme extensionScheme)
Add an extension scheme to the set of extension
schemes used for this file.
|
void |
clearRootExtensions()
Clear all the root extension schemes for the file.
|
Root |
clone()
Create a cloned copy of this root.
|
boolean |
containsRootExtension(AUID extensionSchemeID)
Determines if the root contains the given extension scheme
identifier,
indicating that the corresponding scheme is used in the file.
|
boolean |
containsRootExtension(ExtensionScheme extensionScheme)
Determines if the root contains the given extension scheme, indicating that
the scheme is used in the file.
|
boolean |
containsRootExtension(String schemeURI)
Determines if the root contains the given extension scheme from its
scheme URI or
preferred prefix, indicating that the corresponding
scheme is used in the file.
|
int |
countRootExtensions()
Returns the number of extension schemes attached
to the file.
|
Set<ExtensionScheme> |
getRootExtensions()
Returns the set of extension schemes that are
used for this file.
|
int |
getRootFormatVersion()
Returns the simple integer version number of meta model.
|
Preface |
getRootPreface()
Returns the preface of the file.
|
boolean |
removeRootExtension(AUID extensionScheme)
Remove the identified extension scheme from the set of extension schemes
of this file.
|
boolean |
removeRootExtension(ExtensionScheme extensionScheme)
Remove the given extension scheme from the set of extension schemes
of this file.
|
void |
setRootFormatVersion(Integer rootFormatVerison)
Sets the simple integer version number of meta model.
|
void |
setRootPreface(Preface preface)
Sets the preface of the file.
|
Preface getRootPreface()
Returns the preface of the file.
void setRootPreface(Preface preface) throws NullPointerException
Sets the preface of the file.
preface - Preface of the file.NullPointerException - Cannot set the preface of the file using a
null value.Set<ExtensionScheme> getRootExtensions()
Returns the set of extension schemes that are used for this file. The extension schemes represent meta definitions that are not contained in the AAF baseline.
ApplicationPluginObject.getApplicationScheme(),
DescriptiveMarker.getDescriptiveMetadataScheme(),
InterchangeObject.getApplicationPlugins(),
Preface.getDescriptiveSchemes()void addRootExtension(ExtensionScheme extensionScheme)
Add an extension scheme to the set of extension schemes used for this file.
extensionScheme - Extension scheme to add.getRootExtensions()boolean containsRootExtension(ExtensionScheme extensionScheme) throws NullPointerException
Determines if the root contains the given extension scheme, indicating that the scheme is used in the file.
extensionScheme - Extension scheme to check for.NullPointerException - Cannot check for a root using a null
value.containsRootExtension(AUID),
containsRootExtension(String),
getRootExtensions()boolean containsRootExtension(AUID extensionSchemeID) throws NullPointerException
Determines if the root contains the given extension scheme identifier, indicating that the corresponding scheme is used in the file.
extensionScheme - Identifier for the extension scheme to check for.NullPointerException - Cannot check for a root using a null
value.containsRootExtension(ExtensionScheme),
containsRootExtension(String),
getRootExtensions(),
ExtensionScheme.getSchemeID()boolean containsRootExtension(String schemeURI) throws NullPointerException
Determines if the root contains the given extension scheme from its scheme URI or preferred prefix, indicating that the corresponding scheme is used in the file.
schemeURI - Namespace URI or preferred prefix of the extension scheme to check for.NullPointerException - Cannot check for a root using a null
value.containsRootExtension(ExtensionScheme),
containsRootExtension(AUID),
getRootExtensions(),
ExtensionScheme.getSchemeURI(),
ExtensionScheme.getPreferredPrefix()void clearRootExtensions()
Clear all the root extension schemes for the file.
getRootExtensions()int countRootExtensions()
Returns the number of extension schemes attached to the file.
getRootExtensions()boolean removeRootExtension(ExtensionScheme extensionScheme) throws NullPointerException
Remove the given extension scheme from the set of extension schemes of this file.
extensionScheme - Extension scheme to remove from this file.false if
the extension scheme was not contained.NullPointerException - Cannot remove an extension scheme using a null value.removeRootExtension(AUID),
getRootExtensions()boolean removeRootExtension(AUID extensionScheme) throws NullPointerException
Remove the identified extension scheme from the set of extension schemes of this file.
extensionScheme - Identifier for the extension scheme to remove from this file.false if
the extension scheme was not contained.NullPointerException - Cannot remove an extension scheme using a null value.removeRootExtension(ExtensionScheme),
getRootExtensions()@UInt32 int getRootFormatVersion() throws PropertyNotPresentException
Returns the simple integer version number of meta model. If present, this optional property shall be 12h or greater.
PropertyNotPresentException - The optional root format version property is not
present for this root.void setRootFormatVersion(@UInt32 Integer rootFormatVerison) throws IllegalArgumentException
Sets the simple integer version number of meta model. If present, this optional property shall be 12h or greater.
rootFormatVerison - Simple integer version number of meta model.IllegalArgumentException - Cannot set the root format version to a
value less than 12h (18).Root clone()
Create a cloned copy of this root.
(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.