@MediaClass(uuid1=218169601, uuid2=257, uuid3=12032, uuid4={6,14,43,52,2,6,1,1}, definedName="Preface", aliases="Header", description="The Preface class provides file-wide information and indexes.", symbol="Preface") public class PrefaceImpl extends InterchangeObjectImpl implements Preface, QPreface, Serializable, Cloneable
Implements file-wide information and indexes. An AAF file shall have exactly one header object.
ObjectClassPropertyIDOBJECTMODELVERSION_DEFAULT| Constructor and Description |
|---|
PrefaceImpl()
Creates and initializes a header object, the root object of any AAF persistent unit such
as a file or database representation.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addApplicationScheme(AUID applicationSchemeID)
Adds the identifier of an application metadata scheme to the set of schemes
used in this file.
|
void |
addDescriptiveScheme(AUID descriptiveSchemeID)
Adds the given descriptive metadata scheme identifier to the set of
schemes of this preface, which identify the
descriptive metadata schemes used in the file.
|
void |
addEssenceContainer(AUID containerID)
Adds an essence container to the set of essence containers identifiers of this
preface, which identify the internal essence containers used in the file.
|
void |
addEssenceData(EssenceData essenceData)
Adds an essence data item to the content
storage of this preface.
|
void |
addPackage(Package packageToAdd)
Adds a package to the content storage of this preface.
|
void |
appendIdentification(Identification identification)
Appends the given identification to the list of
identifications of this preface, which each identify an application that created or
modified the file.
|
void |
clearApplicationSchemes()
Remove all application schemes from this preface, omitting this optional property.
|
void |
clearDescriptiveSchemes()
Remove all descriptive schemes from this preface, omitting this optional property.
|
void |
clearEssenceContainers()
Remove all essence containers from this preface, omitting this optional property.
|
void |
clearIdentificationList() |
Preface |
clone()
Create a cloned copy of this interchange object.
|
int |
countApplicationSchemes()
Returns the number of application metadata schemes recorded in the
preface for this file.
|
int |
countDescriptiveSchemes()
Returns the total number of descriptive metadata schemes present
for this preface, which identify the descriptive metadata schemes used in
the file.
|
int |
countEssenceContainers()
Returns the total number of essence containers of this
preface, which identify the internal essence containers used in the file.
|
int |
countEssenceData()
Returns the total number of essence data items stored in the
content storage of this preface.
|
int |
countIdentifications()
Returns the number of identifications in the preface, which
each identify an application that created or modified the file.
|
int |
countPackages(PackageKind packageKind)
Returns the number of matches for the given package kind within
the content storage of this preface.
|
Set<? extends EssenceData> |
enumEssenceData()
Returns a set of all essence data stored in the
content storage of this preface.
|
Set<AUID> |
getApplicationSchemes()
Returns the set of identifiers for application metadata
schemes used in the file.
|
int |
getArchiveDatabaseType() |
ByteOrder |
getByteOrder()
Returns the byte order of the file this preface was read from.
|
ContentStorage |
getContentStorageObject()
Returns the content storage of this preface.
|
Set<AUID> |
getDescriptiveSchemes()
Returns the set of descriptive schemes of this preface, which identify the
descriptive metadata schemes used in the file.
|
Set<String> |
getDescriptiveSchemesStringSet() |
Dictionary |
getDictionaries()
Returns the dictionary of this preface, which contains
all the definitions of the file.
|
Set<AUID> |
getEssenceContainers()
Returns the set of essence containers of this header,
which identify the internal essence containers used in the file.
|
Set<String> |
getEssenceContainersStringSet() |
Set<? extends EssenceData> |
getEssenceData()
Returns all the essence data objects from the
content storage of this preface.
|
Set<? extends EssenceData> |
getEssenceData(CriteriaType mediaCriteria)
Returns a set of essence data from the content storage of this
preface that matches the given media criteria.
|
TimeStamp |
getFileLastModified()
Return the last modified time stamp of
this preface, which specifies the time and date that this file was last modified.
|
String |
getFileLastModifiedString() |
VersionType |
getFormatVersion()
Return the file version property of the preface.
|
String |
getFormatVersionString() |
Identification |
getGeneration()
Gets the generation of this object, which identifies when this object was created
or last modified.
|
Identification |
getIdentificationAt(int index)
Retrieves the identification at the given index through the
list of identifications of this preface, which each identify an application that created or
modified the file.
|
List<Identification> |
getIdentifications()
Returns the list of identifications contained within
this preface, which each identify an application that created or modified the file.
|
Identification |
getLastIdentification()
Returns the identification of the last application
that modified the file.
|
AUID |
getLinkedGenerationID()
Shortcut to get the AUID of the identification
representing this object's generation.
|
ProductVersion |
getMajApiVersion()
Return the version of the MAJ API currently
running on this machine, which implements these interfaces.
|
int |
getObjectModelVersion()
Returns the version of the persistent storage format for objects of this preface.
|
AUID |
getOperationalPattern()
Returns the identifier of the MXF operational pattern or AAF protocol that
the file of this preface complies with.
|
String |
getOperationalPatternString() |
Set<? extends Package> |
getPackages()
Returns all the packages stored in the content storage
of this preface.
|
Set<? extends Package> |
getPackages(SearchCriteria searchCriteria)
Returns a set of packages stored in the content storage of this preface that match the given
search criteria. |
Package |
getPrimaryPackage()
Returns the primary package identifier for the file of this preface, which specifies the
package that an MXF application treats as the default or primary package.
|
static ByteOrder |
initializeByteOrder() |
static ContentStorage |
initializeContentStorageObject() |
static Dictionary |
initializeDictionaries() |
static TimeStamp |
initializeFileLastModified() |
static VersionType |
initializeFormatVersion() |
static List<Identification> |
initializeIdentificationList() |
boolean |
isApplicationSchemePresent(AUID applicationSchemeID)
Returns
true if the given identifier matches one of the
application metadata scheme stated to be in the file. |
boolean |
isDescriptiveSchemePresent(AUID descriptiveSchemeID)
Returns
true if the descriptive metadata scheme with
the given identifier is in set of schemes of this preface; otherwise false. |
boolean |
isEssenceContainerPresent(AUID essenceContainerID)
Returns
true if the essence containers with the given
identifier is present for this preface; otherwise false. |
boolean |
isEssenceDataPresent(PackageID filPackageID)
Returns
true if essence data identified by the
given package id is present in the content storage of this preface. |
EssenceData |
lookupEssenceData(PackageID packageID)
Looks up and returns the essence data that matches the given
package id from the content storage
of this preface.
|
Identification |
lookupIdentification(AUID generation)
Returns the identification that matches the given
generation identifier from the list of identifications of applications that created
or modified the file of this preface.
|
Package |
lookupPackage(PackageID packageID)
Returns the package that matches the given package id
stored in the content storage of this preface.
|
void |
prependIdentification(Identification ident) |
void |
removeApplicationScheme(AUID applicationSchemeID)
Remove an application metadata scheme from the set of application
schemes of this file.
|
void |
removeDescriptiveScheme(AUID descriptiveSchemeID)
Removes the given descriptive metadata scheme identifier from the
set of schemes of this preface, which identify the
descriptive metadata schemes used in the file.
|
void |
removeEssenceContainer(AUID essenceContainerID) |
void |
removeEssenceData(EssenceData essenceData)
Removes the given essence data item from the content
storage of this preface.
|
void |
removePackage(Package packageToRemove)
Removes the given package from the content storage of
this preface.
|
void |
setArchiveDatabaseType(Integer archiveDatabaseType) |
void |
setByteOrder(Object byteOrder) |
void |
setContentStorageObject(ContentStorage contentStorageObject) |
void |
setDescriptiveSchemesStringSet(Set<String> descriptiveSchemes) |
void |
setDictionaries(Dictionary dictionaries) |
void |
setEssenceContainersStringSet(Set<String> essenceContainers) |
void |
setFileLastModified(TimeStamp fileLastModified)
Set the last modified time stamp of
this preface, which specifies the time and date that this file was last modified.
|
void |
setFileLastModifiedString(String fileLastModified) |
void |
setFormatVersion(VersionType formatVersion) |
void |
setFormatVersionString(String formatVersion) |
void |
setObjectModelVersion(Integer objectModelVersion) |
void |
setOperationalPattern(AUID operationalPatternID)
Sets the MXF operational pattern or AAF protocol that the file of this
preface complies with.
|
void |
setOperationPatternString(String operationalPattern) |
void |
setPrimaryPackage(Package primaryPackage)
Sets the primary package identifier for the file of the preface, which specifies the package
that an MXF application treats as the default or primary package.
|
boolean |
updateDictionaries()
Iterate through the content storage packages and make sure the dictionary contains
all the referenced definitions, adding any missing definitions.
|
void |
updateEssenceContainers()
Ensures that the contents of the essence containers property
is in sync with the file's metadata.
|
addApplicationPlugin, appendXMLChildren, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getComment, getLinkedGenerationIDString, getObjectClass, getPersistentID, getPersistentIndex, hashCode, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setLinkedGenerationIDString, setObjectClass, setPersistentID, setPersistentIndex, toStringaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexpublic PrefaceImpl()
Creates and initializes a header object, the root object of any AAF persistent unit such as a file or database representation.
@MediaSetAdd(value="DescriptiveSchemes") public void addDescriptiveScheme(AUID descriptiveSchemeID) throws NullPointerException
PrefaceAdds the given descriptive metadata scheme identifier to the set of schemes of this preface, which identify the descriptive metadata schemes used in the file. If the optional set of descriptive metadata schemes property is omitted, it will become present after successful completion of this method.
addDescriptiveScheme in interface PrefacedescriptiveSchemeID - Descriptive metadata scheme identifier to add to the set of
this preface.NullPointerException - The given descriptive metadata scheme identifier is null.DescriptiveFramework,
DescriptiveClippublic void addEssenceData(EssenceData essenceData) throws DuplicatePackageIDException, NullPointerException
PrefaceAdds an essence data item to the content storage of this preface.
addEssenceData in interface PrefaceessenceData - Essence data to add to the content storage of this preface.DuplicatePackageIDException - Essence data with the same package id is already contained
in the content storage of this preface.NullPointerException - The given essence data item is null.Preface.getContentStorageObject(),
ContentStorage.addEssenceDataObject(EssenceData)public void addPackage(Package packageToAdd) throws NullPointerException, DuplicatePackageIDException
PrefaceAdds a package to the content storage of this preface.
addPackage in interface PrefacepackageToAdd - Package to add to the content storage of this preface.NullPointerException - The given package is null.DuplicatePackageIDException - A package with the same package id is already
contained in the content storage of this preface.Preface.getContentStorageObject(),
ContentStorage.addPackage(Package)@MediaListAppend(value="IdentificationList") public void appendIdentification(Identification identification) throws NullPointerException
PrefaceAppends the given identification to the list of identifications of this preface, which each identify an application that created or modified the file. The identification at the end of the list should represent the most recent application to modify the file. This method does not attempt to identify duplicate identifications, so it will succeed even if an identical identification is already contained in the list.
appendIdentification in interface Prefaceidentification - Identification to append to the list of identifications of this preface.NullPointerException - The given identification is null.@MediaListPrepend(value="IdentificationList") public void prependIdentification(Identification ident) throws NullPointerException
NullPointerException@MediaPropertyCount(value="DescriptiveSchemes") public int countDescriptiveSchemes()
PrefaceReturns the total number of descriptive metadata schemes present for this preface, which identify the descriptive metadata schemes used in the file.
countDescriptiveSchemes in interface Preface@MediaPropertyCount(value="EssenceContainers") public int countEssenceContainers() throws PropertyNotPresentException
PrefaceReturns the total number of essence containers of this preface, which identify the internal essence containers used in the file.
countEssenceContainers in interface PrefacePropertyNotPresentException - Essence containers are not present
in the file of the preface.public int countEssenceData()
PrefaceReturns the total number of essence data items stored in the content storage of this preface.
countEssenceData in interface PrefacePreface.getContentStorageObject(),
ContentStorage.countEssenceDataObjects()@MediaPropertyCount(value="IdentificationList") public int countIdentifications()
PrefaceReturns the number of identifications in the preface, which each identify an application that created or modified the file.
countIdentifications in interface Preface@MediaPropertyClear(value="IdentificationList") public void clearIdentificationList()
public int countPackages(PackageKind packageKind) throws NullPointerException
PrefaceReturns the number of matches for the given package kind within
the content storage of this preface. Use PackageKind.AllPackages
to count the total number of packages.
countPackages in interface PrefacepackageKind - The kind of packages to count.NullPointerExceptionPreface.getContentStorageObject(),
ContentStorage.countPackages(PackageKind)public Set<? extends EssenceData> enumEssenceData()
PrefaceReturns a set of all essence data stored in the content storage of this preface.
enumEssenceData in interface PrefacePreface.getEssenceData(CriteriaType),
Preface.getContentStorageObject(),
ContentStorage.enumEssenceDataObjects()@MediaProperty(uuid1=100729092, uuid2=513, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ContentStorageObject", aliases="Content", typeName="ContentStorageStrongReference", optional=false, uniqueIdentifier=false, pid=15107, symbol="ContentStorageObject") public ContentStorage getContentStorageObject()
PrefaceReturns the content storage of this preface. This is the Content property of a preface.
getContentStorageObject in interface Preface@MediaPropertySetter(value="ContentStorageObject") public void setContentStorageObject(ContentStorage contentStorageObject) throws NullPointerException
NullPointerExceptionpublic static final ContentStorage initializeContentStorageObject()
@MediaProperty(uuid1=16908816, uuid2=514, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="DescriptiveSchemes", aliases="DMSchemes", typeName="AUIDSet", optional=false, uniqueIdentifier=false, pid=15115, symbol="DescriptiveSchemes") public Set<AUID> getDescriptiveSchemes() throws PropertyNotPresentException
PrefaceReturns the set of descriptive schemes of this preface, which identify the descriptive metadata schemes used in the file.
getDescriptiveSchemes in interface PrefacePropertyNotPresentException - The optional set of descriptive metadata schemes is
not present in this preface.DescriptiveFramework,
DescriptiveClip,
Root.getRootExtensions(),
DescriptiveMarker.getDescriptiveMetadataScheme(),
ExtensionScheme@MediaPropertyClear(value="DescriptiveSchemes") public void clearDescriptiveSchemes()
PrefaceRemove all descriptive schemes from this preface, omitting this optional property.
clearDescriptiveSchemes in interface PrefacePreface.getDescriptiveSchemes(),
Preface.countDescriptiveSchemes()@MediaProperty(uuid1=16908816, uuid2=513, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="EssenceContainers", typeName="AUIDSet", optional=true, uniqueIdentifier=false, pid=15114, symbol="EssenceContainers") public Set<AUID> getEssenceContainers() throws PropertyNotPresentException
Returns the set of essence containers of this header, which identify the internal essence containers used in the file. This is an optional property that is automatically maintained.
getEssenceContainers in interface PrefacePropertyNotPresentException - The optional set of essence containers is not present
for this preface.ContainerConstant,
ContainerDefinition@MediaSetAdd(value="EssenceContainers") public void addEssenceContainer(AUID containerID) throws NullPointerException
PrefaceAdds an essence container to the set of essence containers identifiers of this preface, which identify the internal essence containers used in the file. The essence container property is optional. Adding an optional identifier causes the essence containers property to become present.
addEssenceContainer in interface PrefacecontainerID - Essence container identifier to add to the set of essence
containers of this prefance.NullPointerException - Cannot add a null identifier to the set of essence
containers.DefinitionObject.getAUID(),
Preface.getEssenceContainers(),
Preface.isEssenceContainerPresent(AUID)@MediaPropertyRemove(value="EssenceContainers") public void removeEssenceContainer(AUID essenceContainerID) throws NullPointerException, InvalidParameterException, PropertyNotPresentException
@MediaPropertyClear(value="EssenceContainers") public void clearEssenceContainers()
PrefaceRemove all essence containers from this preface, omitting this optional property.
clearEssenceContainers in interface PrefacePreface.getEssenceContainers(),
Preface.countEssenceContainers()public Set<? extends EssenceData> getEssenceData(CriteriaType mediaCriteria) throws NullPointerException
PrefaceReturns a set of essence data from the content storage of this
preface that matches the given media criteria.
If the media criteria is CriteriaType.AnyRepresentation
then all essence data that is stored in the content storage of this
preface is included, producing the same result as calling Preface.enumEssenceData().
getEssenceData in interface PrefacemediaCriteria - Criteria for selecting essence data from storage.NullPointerExceptionPreface.getEssenceData(),
Preface.enumEssenceData(),
Preface.getContentStorageObject(),
ContentStorage.getEssenceDataObjects(CriteriaType)public Set<? extends EssenceData> getEssenceData()
PrefaceReturns all the essence data objects from the content storage of this preface.
getEssenceData in interface PrefacePreface.enumEssenceData(),
Preface.getEssenceData(CriteriaType),
ContentStorage.getEssenceDataObjects()@MediaProperty(uuid1=50397697, uuid2=1280, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="FormatVersion", aliases="Version", typeName="VersionType", optional=false, uniqueIdentifier=false, pid=15109, symbol="FormatVersion") public VersionType getFormatVersion()
PrefaceReturn the file version property of the preface.
getFormatVersion in interface Preface@MediaPropertySetter(value="FormatVersion") public void setFormatVersion(VersionType formatVersion) throws NullPointerException
NullPointerExceptionpublic static final VersionType initializeFormatVersion()
@MediaListGetAt(value="IdentificationList") public Identification getIdentificationAt(int index) throws IndexOutOfBoundsException
PrefaceRetrieves the identification at the given index through the list of identifications of this preface, which each identify an application that created or modified the file.
getIdentificationAt in interface Prefaceindex - 0-based index of the identification to retrieve from the list of identifications
of this preface.IndexOutOfBoundsException - The given index is outside the acceptable range for the
current list of identifications of this preface.@MediaProperty(uuid1=100729092, uuid2=1540, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="IdentificationList", typeName="IdentificationStrongReferenceVector", optional=false, uniqueIdentifier=false, pid=15110, symbol="IdentificationList") public List<Identification> getIdentifications()
PrefaceReturns the list of identifications contained within this preface, which each identify an application that created or modified the file.
getIdentifications in interface PrefaceTypeDefinitions.IdentificationStrongReferenceVectorpublic static final List<Identification> initializeIdentificationList()
public Identification getLastIdentification()
PrefaceReturns the identification of the last application that modified the file.
getLastIdentification in interface Preface@MediaProperty(uuid1=117571856, uuid2=516, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="FileLastModified", aliases="LastModified", typeName="TimeStamp", optional=false, uniqueIdentifier=false, pid=15106, symbol="FileLastModified") public TimeStamp getFileLastModified()
PrefaceReturn the last modified time stamp of this preface, which specifies the time and date that this file was last modified.
getFileLastModified in interface Preface@MediaPropertySetter(value="FileLastModified") public void setFileLastModified(TimeStamp fileLastModified) throws NullPointerException
PrefaceSet the last modified time stamp of
this preface, which specifies the time and date that this file was last modified.
This value should match that of the
most recent identification.
setFileLastModified in interface PrefacefileLastModified - Time stamp for the most recent modification of the file.NullPointerException - Cannot set the timestamp using a null value.Preface.getLastIdentification()public static final TimeStamp initializeFileLastModified()
public Set<? extends Package> getPackages(SearchCriteria searchCriteria)
PrefaceReturns a set of packages stored in the content storage of this preface that match the given
search criteria. If the search criteria is
null, all packages are returned.
getPackages in interface PrefacesearchCriteria - Search criteria to use to filter the set of packages
returned.null. The
set does not clone packages it contains.Preface.getContentStorageObject(),
Preface.getPackages(),
ContentStorage.getPackages(SearchCriteria),
ContentStorage.getPackages()public Set<? extends Package> getPackages()
PrefaceReturns all the packages stored in the content storage of this preface.
getPackages in interface PrefacePreface.getContentStorageObject(),
Preface.getPackages(SearchCriteria),
ContentStorage.getPackages()@MediaProperty(uuid1=16908803, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="OperationalPattern", typeName="AUID", optional=true, uniqueIdentifier=false, pid=15113, symbol="OperationalPattern") public AUID getOperationalPattern() throws PropertyNotPresentException
PrefaceReturns the identifier of the MXF operational pattern or AAF protocol that the file of this preface complies with. This is an optional property.
getOperationalPattern in interface PrefacePropertyNotPresentException - Property is not present in the preface.OperationalPatternConstant@MediaPropertySetter(value="OperationalPattern") public void setOperationalPattern(AUID operationalPatternID)
PrefaceSets the MXF operational pattern or AAF protocol that the file of this
preface complies with. Set this optional property to null to
omit it.
setOperationalPattern in interface PrefaceoperationalPatternID - Operational pattern identifier for the preface.OperationalPatternConstant@MediaProperty(uuid1=100729092, uuid2=264, uuid3=0, uuid4={6,14,43,52,1,1,1,4}, definedName="PrimaryPackage", typeName="PackageWeakReference", optional=true, uniqueIdentifier=false, pid=15112, symbol="PrimaryPackage") public Package getPrimaryPackage() throws PropertyNotPresentException
PrefaceReturns the primary package identifier for the file of this preface, which specifies the package that an MXF application treats as the default or primary package. This is an optional property.
getPrimaryPackage in interface PrefacePropertyNotPresentException - The optional primary package identifier is not present
in the preface.PackageID.getMaterial()@MediaPropertySetter(value="PrimaryPackage") public void setPrimaryPackage(Package primaryPackage)
PrefaceSets the primary package identifier for the file of the preface, which specifies the package
that an MXF application treats as the default or primary package. Set this optional property to
null to omit it.
setPrimaryPackage in interface PrefaceprimaryPackage - Primary package identifier for the file of this preface.PackageID.getMaterial()public ProductVersion getMajApiVersion()
PrefaceReturn the version of the MAJ API currently running on this machine, which implements these interfaces.
getMajApiVersion in interface PrefacePreface.getLastIdentification(),
Identification.getRefImplVersion()@MediaPropertyContains(value="DescriptiveSchemes") public boolean isDescriptiveSchemePresent(AUID descriptiveSchemeID) throws NullPointerException
PrefaceReturns true if the descriptive metadata scheme with
the given identifier is in set of schemes of this preface; otherwise false.
isDescriptiveSchemePresent in interface PrefacedescriptiveSchemeID - Identifier of the descriptive metadata scheme to check for.NullPointerException - The given identifier is null.DescriptiveFramework,
DescriptiveClip@MediaPropertyContains(value="EssenceContainers") public boolean isEssenceContainerPresent(AUID essenceContainerID) throws NullPointerException
PrefaceReturns true if the essence containers with the given
identifier is present for this preface; otherwise false. The set
of essence containers identify the internal essence containers used in the file.
The essence containers property of a preface is optional.
isEssenceContainerPresent in interface PrefaceessenceContainerID - Identifier of the type of essence container to check for.NullPointerException - The given identifier is null.ContainerConstant,
ContainerDefinition,
DefinitionObject.getAUID()public boolean isEssenceDataPresent(PackageID filPackageID) throws NullPointerException, InvalidParameterException
PrefaceReturns true if essence data identified by the
given package id is present in the content storage of this preface.
isEssenceDataPresent in interface PrefacefilPackageID - Identifier of a file package that may be present in the content storage of this preface.NullPointerException - The given package id is null.InvalidParameterException - The given file package id does not identify a file source package.Preface.getContentStorageObject(),
ContentStorage.isEssenceDataPresent(PackageID)public EssenceData lookupEssenceData(PackageID packageID) throws NullPointerException, PackageNotFoundException
PrefaceLooks up and returns the essence data that matches the given package id from the content storage of this preface.
lookupEssenceData in interface PrefacepackageID - Identifier for essence data stored in the content storage of this preface.NullPointerException - The given package id is null.PackageNotFoundException - Essence data identified with the given package id is not
stored in the content storage of the preface.Preface.getContentStorageObject(),
ContentStorage.lookupEssenceDataObject(PackageID)public Identification lookupIdentification(AUID generation) throws NullPointerException, ObjectNotFoundException
PrefaceReturns the identification that matches the given generation identifier from the list of identifications of applications that created or modified the file of this preface.
lookupIdentification in interface Prefacegeneration - Unique generation identifier to retrieve from the list of identifications
of this preface.NullPointerException - The given generation identifier is null.ObjectNotFoundException - An identification with the given identifier was not found
in the list of identifications of this preface.public Package lookupPackage(PackageID packageID) throws NullPointerException, PackageNotFoundException
PrefaceReturns the package that matches the given package id stored in the content storage of this preface.
lookupPackage in interface PrefacepackageID - The identifier of the package to look up in the content storage of this preface.NullPointerException - The given package identifier is null.PackageNotFoundException - A package with the given identifier was not found in the content storage of
this preface.Preface.getContentStorageObject(),
ContentStorage.lookupPackage(PackageID)@MediaPropertyRemove(value="DescriptiveSchemes") public void removeDescriptiveScheme(AUID descriptiveSchemeID) throws NullPointerException, InvalidParameterException, PropertyNotPresentException
PrefaceRemoves the given descriptive metadata scheme identifier from the set of schemes of this preface, which identify the descriptive metadata schemes used in the file. If the
removeDescriptiveScheme in interface PrefacedescriptiveSchemeID - Descriptive metadata scheme identifier to remove from the
set of schemes of this preface.NullPointerException - The given scheme identifier is null.InvalidParameterException - The given descriptive scheme identifier is
not present in the list of schemes of this preface.PropertyNotPresentException - The optional set of descriptive metadata schemes property is
not present in this preface.DescriptiveFramework,
DescriptiveClippublic void removeEssenceData(EssenceData essenceData) throws NullPointerException, EssenceNotFoundException
PrefaceRemoves the given essence data item from the content storage of this preface.
removeEssenceData in interface PrefaceessenceData - Essence data to remove from the content storage of this preface.NullPointerException - The given essence data item is null.EssenceNotFoundException - The given essence data item is not contained in the
content storage of this preface.Preface.getContentStorageObject(),
ContentStorage.removeEssenceDataObject(EssenceData)public void removePackage(Package packageToRemove) throws NullPointerException, PackageNotFoundException
PrefaceRemoves the given package from the content storage of this preface.
removePackage in interface PrefacepackageToRemove - Package to remove from the preface.NullPointerException - The given package to remove is null.PackageNotFoundException - The given package is not contained
in the content storage of this preface.Preface.getContentStorageObject(),
ContentStorage.removePackage(Package)public void updateEssenceContainers()
PrefaceEnsures that the contents of the essence containers property
is in sync with the file's metadata. If this method succeeds, the essence containers
property will contain identifiers of all container definitions
referenced by source packages in the file of the preface.
If the property isn't present it will be created. It is recommended that this method is called before any other of the methods affecting the essence containers can be called.
updateEssenceContainers in interface PrefaceContainerDefinitionpublic Identification getGeneration() throws InvalidParameterException, ObjectNotAttachedException
InterchangeObjectGets the generation of this object, which identifies when this object was created or last modified.
This method will succeed if generation tracking is enabled for
this object. Call InterchangeObject.enableGenerationTracking() and
InterchangeObject.disableGenerationTracking() to control generation tracking for
this object. Call InterchangeObject.isGenerationTracked() to determine if
generation tracking is currently enabled for this object.
getGeneration in interface InterchangeObjectgetGeneration in class InterchangeObjectImplInvalidParameterException - Generation tracking is not enabled
for this object.ObjectNotAttachedException - This object is not attached to a file
from which generation information can be obtained.public AUID getLinkedGenerationID()
InterchangeObjectShortcut to get the AUID of the identification representing this object's generation.
This method will succeed if generation tracking is enabled for
this object. Call InterchangeObject.enableGenerationTracking() and
InterchangeObject.disableGenerationTracking() to control generation tracking for
this object. Call InterchangeObject.isGenerationTracked() to determine if
generation tracking is currently enabled for this object.
getLinkedGenerationID in interface InterchangeObjectgetLinkedGenerationID in class InterchangeObjectImplInterchangeObject.getGeneration(),
InterchangeObject.getLinkedGenerationID()@MediaProperty(uuid1=50397697, uuid2=512, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="ByteOrder", typeName="Int16", optional=false, uniqueIdentifier=false, pid=15105, symbol="ByteOrder") public ByteOrder getByteOrder()
PrefaceReturns the byte order of the file this preface was read from.
getByteOrder in interface PrefaceByteOrder.getAAFByteOrderCode()@MediaPropertySetter(value="ByteOrder") public void setByteOrder(Object byteOrder) throws NullPointerException
NullPointerExceptionpublic static final ByteOrder initializeByteOrder()
@MediaProperty(uuid1=100729092, uuid2=514, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Dictionaries", aliases={"Dictionary","HeaderDictionary"}, typeName="DictionaryStrongReference", optional=false, uniqueIdentifier=false, pid=15108, symbol="Dictionaries") public Dictionary getDictionaries()
PrefaceReturns the dictionary of this preface, which contains all the definitions of the file. The dictionary is automatically created when the preface object is created.
getDictionaries in interface PrefaceTypeDefinitions.DictionaryStrongReference@MediaPropertySetter(value="Dictionaries") public void setDictionaries(Dictionary dictionaries) throws NullPointerException
NullPointerExceptionpublic static final Dictionary initializeDictionaries()
@MediaProperty(uuid1=50397697, uuid2=1024, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ObjectModelVersion", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=15111, symbol="ObjectModelVersion") public int getObjectModelVersion()
PrefaceReturns the version of the persistent storage format for objects of this preface.
getObjectModelVersion in interface Preface@MediaPropertySetter(value="ObjectModelVersion") public void setObjectModelVersion(Integer objectModelVersion) throws IllegalArgumentException
IllegalArgumentException@MediaProperty(uuid1=16908816, uuid2=515, uuid3=0, uuid4={6,14,43,52,1,1,1,12}, definedName="ApplicationSchemes", aliases={"ApplicationMetadataSchemes","ApplicationSchemesBatch"}, typeName="AUIDSet", optional=true, uniqueIdentifier=false, pid=0, symbol="ApplicationSchemes") public Set<AUID> getApplicationSchemes() throws PropertyNotPresentException
PrefaceReturns the set of identifiers for application metadata schemes used in the file. This is an optional property.
getApplicationSchemes in interface PrefacePropertyNotPresentException - The optional application schemes property is not
present in this preface.Preface.isApplicationSchemePresent(AUID),
Preface.addApplicationScheme(AUID),
ExtensionScheme@MediaSetAdd(value="ApplicationSchemes") public void addApplicationScheme(AUID applicationSchemeID) throws NullPointerException
PrefaceAdds the identifier of an application metadata scheme to the set of schemes used in this file. If this optional property is omitted, successful completion of this property will make the property present.
addApplicationScheme in interface PrefaceapplicationSchemeID - Application metadata scheme identifier to add.NullPointerException - Cannot add a null identifier to the set of application schemes.Preface.getApplicationSchemes(),
Preface.isApplicationSchemePresent(AUID)@MediaPropertyClear(value="ApplicationSchemes") public void clearApplicationSchemes()
PrefaceRemove all application schemes from this preface, omitting this optional property.
clearApplicationSchemes in interface PrefacePreface.getApplicationSchemes(),
Preface.countApplicationSchemes()@MediaPropertyCount(value="ApplicationScehemes") public int countApplicationSchemes()
PrefaceReturns the number of application metadata schemes recorded in the preface for this file.
countApplicationSchemes in interface PrefacePreface.getApplicationSchemes()@MediaPropertyContains(value="ApplicationSchemes") public boolean isApplicationSchemePresent(AUID applicationSchemeID) throws PropertyNotPresentException, NullPointerException
PrefaceReturns true if the given identifier matches one of the
application metadata scheme stated to be in the file.
isApplicationSchemePresent in interface PrefaceapplicationSchemeID - Application scheme identifier for check for.PropertyNotPresentException - The optional application schemes property is not present in this
preface.NullPointerException - Cannot test for an application scheme using a null pointer.Preface.getApplicationSchemes()@MediaPropertyRemove(value="ApplicationSchemes") public void removeApplicationScheme(AUID applicationSchemeID) throws NullPointerException, InvalidParameterException, PropertyNotPresentException
PrefaceRemove an application metadata scheme from the set of application schemes of this file.
removeApplicationScheme in interface PrefaceapplicationSchemeID - Identifier of the application metadata scheme to remove.NullPointerException - Cannot remove an application metadata schemes using a null identifier.InvalidParameterException - The given application metadata scheme identifier is not present in
the set of application schemes of this preface.PropertyNotPresentException - The optional application schemes property is not present for this
preface.Preface.getApplicationSchemes(),
Preface.isApplicationSchemePresent(AUID)public boolean updateDictionaries()
PrefaceIterate through the content storage packages and make sure the dictionary contains all the referenced definitions, adding any missing definitions.
updateDictionaries in interface PrefacePreface.getDictionaries()public Preface clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface InterchangeObjectclone in interface Prefaceclone in class InterchangeObjectImplpublic String getFileLastModifiedString()
public void setFileLastModifiedString(String fileLastModified)
public String getFormatVersionString()
public void setFormatVersionString(String formatVersion)
public String getOperationalPatternString()
public void setOperationPatternString(String operationalPattern)
public void setEssenceContainersStringSet(Set<String> essenceContainers)
public void setDescriptiveSchemesStringSet(Set<String> descriptiveSchemes)
@MediaProperty(uuid1=-718985234, uuid2=-17763, uuid3=19755, uuid4={-110,-66,-23,58,42,7,61,102}, definedName="Archive database type", symbol="Archive_database_type", aliases="Archive_database_type", typeName="Int32", optional=true, uniqueIdentifier=false, pid=0, prefix="q", namespace="http://www.quantel.com/genQ/extensions") @Int32 public int getArchiveDatabaseType() throws PropertyNotPresentException
getArchiveDatabaseType in interface QPrefacePropertyNotPresentException@MediaPropertySetter(value="Archive database type") public void setArchiveDatabaseType(@Int32 Integer archiveDatabaseType)
setArchiveDatabaseType in interface QPreface(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.