public interface ContentStorage extends InterchangeObject
Specifies storage for content that has package and essence data within it. An AAF file shall have exactly one content storage.
Note that there is no requirement for every package stored in a content storage to have its essence data stored within the same content storage. However, it is likely that if some essence data is stored in this content storage, its associated metadata file source package is also stored.
| Modifier and Type | Method and Description |
|---|---|
void |
addEssenceDataObject(EssenceData essenceData)
Adds the given essence data item to the set of those stored
in this content storage..
|
void |
addPackage(Package packageToAdd)
Adds the given package to the set of packages in this content storage.
|
ContentStorage |
clone()
Create a cloned copy of this content storage.
|
int |
countEssenceDataObjects()
Returns the total number of essence data items
in this content storage.
|
int |
countPackages()
Returns the total number of packages in this content storage.
|
int |
countPackages(PackageKind packageKind)
Find the number of matches for the given package kind
stored in this content storage.
|
Set<? extends EssenceData> |
enumEssenceDataObjects()
Returns the complete set of essence data contained within this content
storage object.
|
Set<? extends EssenceData> |
getEssenceDataObjects()
Returns the complete set of essence data contained within this content
storage object.
|
Set<? extends EssenceData> |
getEssenceDataObjects(CriteriaType mediaCriteria)
Returns the set of essence data contained within this content
storage object, filtered according to the media criteria provided.
|
Set<? extends Package> |
getPackages()
Returns a set of all packages stored in this content storage.
|
Set<? extends Package> |
getPackages(SearchCriteria searchCriteria)
Returns a set of packages from this content storage according
to a given search criteria.
|
boolean |
isEssenceDataPresent(PackageID filePackageID)
Returns
true if essence data identified by the given
package id is contained in this content storage. |
EssenceData |
lookupEssenceDataObject(PackageID packageId)
Looks up and returns an essence data item stored in this content storage
that matches the given package id.
|
Package |
lookupPackage(PackageID packageID)
Returns the package that matches the given package id
from the set of packages in this content storage.
|
void |
removeEssenceDataObject(EssenceData essenceData)
Removes the given essence data item from the set stored in
this content storage.
|
void |
removePackage(Package packageToRemove)
Removes the given package from the set stored in this content storage.
|
addApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexPackage lookupPackage(PackageID packageID) throws NullPointerException, PackageNotFoundException
Returns the package that matches the given package id from the set of packages in this content storage.
packageID - The identifier of the package to find in this content storage.NullPointerException - The given package identifier is null.PackageNotFoundException - The requested package is not stored in this content storage.@NumTracks int countPackages(PackageKind packageKind) throws NullPointerException
Find the number of matches for the given package kind stored in this content storage.
packageKind - The kind of package to count.NullPointerException - The given package kind is null.countPackages()int countPackages()
Returns the total number of packages in this content storage.
countPackages(PackageKind)Set<? extends Package> getPackages(SearchCriteria searchCriteria)
Returns a set of packages from this content storage according
to a given search criteria. If the
search criteria is null then all of the packages in storage are returned.
searchCriteria - Search criteria to filter the set of stored packages of this content
storage with.SearchCriteria,
Preface.getPackages(SearchCriteria),
TypeDefinitions.PackageStrongReferenceSetSet<? extends Package> getPackages()
Returns a set of all packages stored in this content storage.
getPackages(SearchCriteria),
Preface.getPackages(SearchCriteria)void addPackage(Package packageToAdd) throws NullPointerException, DuplicatePackageIDException
Adds the given package to the set of packages in this content storage.
packageToAdd - Package to add to this content storage.NullPointerException - The given package is null.DuplicatePackageIDException - The given package is already contained in this content
storage.void removePackage(Package packageToRemove) throws NullPointerException, PackageNotFoundException
Removes the given package from the set stored in this content storage.
packageToRemove - Package to remove from this content storage.NullPointerException - The given package to remove is null.PackageNotFoundException - The given package is not current contained in this content storage.@UInt32 int countEssenceDataObjects()
Returns the total number of essence data items in this content storage.
@Bool boolean isEssenceDataPresent(PackageID filePackageID) throws NullPointerException
Returns true if essence data identified by the given
package id is contained in this content storage.
filePackageID - Identifier of the essence data to check for within this content storage.NullPointerException - One or more of the arguments in null.Set<? extends EssenceData> enumEssenceDataObjects() throws PropertyNotPresentException
Returns the complete set of essence data contained within this content storage object. Essence data does not have to be carried in the same container as the metadata, so this is an optional property.
Calling this method produces the same result as calling getEssenceData(CriteriaType.AnyRepresentation).
PropertyNotPresentException - No essence data objects are present in this content storage.getEssenceDataObjects(),
Preface.enumEssenceData(),
TypeDefinitions.EssenceDataStrongReferenceSetSet<? extends EssenceData> getEssenceDataObjects() throws PropertyNotPresentException
Returns the complete set of essence data contained within this content storage object. Essence data does not have to be carried in the same container as the metadata, so this is an optional property.
Calling this method produces the same result as calling getEssenceData(CriteriaType.AnyRepresentation).
PropertyNotPresentException - No essence data objects are present in this content storage.getEssenceDataObjects(CriteriaType),
enumEssenceDataObjects(),
Preface.enumEssenceData(),
TypeDefinitions.EssenceDataStrongReferenceSetSet<? extends EssenceData> getEssenceDataObjects(CriteriaType mediaCriteria)
Returns the set of essence data contained within this content storage object, filtered according to the media criteria provided.
If the mediaCriteria is set to CriteriaType.AnyRepresentation, all
essence data is returned.
mediaCriteria - Criteria to use to select the required essence data.enumEssenceDataObjects(),
Preface.getEssenceData(CriteriaType),
TypeDefinitions.EssenceDataStrongReferenceSetvoid addEssenceDataObject(EssenceData essenceData) throws DuplicatePackageIDException, NullPointerException
Adds the given essence data item to the set of those stored in this content storage..
essenceData - Essence data object to add to those stored in this content storage.DuplicatePackageIDException - The given package has already been added.
The validation is done by comparing package ids, which should be unique amongst all essence
data in a content storage unit.NullPointerException - The given essence data item is null.EssenceData.getLinkedPackageID()void removeEssenceDataObject(EssenceData essenceData) throws NullPointerException, EssenceNotFoundException
Removes the given essence data item from the set stored in this content storage.
essenceData - Essence data to remove from this content storage.NullPointerException - The given essence data item is null.EssenceNotFoundException - The given essence data item is not currently contained in
this content storage.EssenceData lookupEssenceDataObject(PackageID packageId) throws NullPointerException, PackageNotFoundException
Looks up and returns an essence data item stored in this content storage that matches the given package id.
packageId - The package id identifying the essence data stored in this content storage.NullPointerException - The given essece data package id is null.PackageNotFoundException - The requested essence data was not found stored in this content
storage.ContentStorage clone()
Create a cloned copy of this content storage.
clone in interface InterchangeObjectclone in interface MediaEntity(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.