|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ContentStorage
Specifies storage for content that has mob and essence data within it. An AAF file shall have exactly one content storage.
Note that there is no requirement for every mob 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 mob is also stored.
makeContentStorage()
,
Header.getContentStorage()
Method Summary | |
---|---|
void |
addEssenceData(EssenceData essenceData)
Adds the given essence data item to the set of those stored in this content storage.. |
void |
addMob(Mob mob)
Adds the given mob to the set of mobs in this content storage. |
int |
countEssenceData()
Returns the total number of essence data items in this content storage. |
int |
countMobs(MobKind mobKind)
Find the number of matches for the given mob kind stored in this content storage. |
Set<? extends EssenceData> |
enumEssenceData()
Returns the complete set of essence data contained within this content storage object. |
Set<? extends EssenceData> |
getEssenceData(CriteriaType mediaCriteria)
Returns the set of essence data contained within this content storage object, filtered according to the media criteria provided. |
Set<? extends Mob> |
getMobs(SearchCriteria searchCriteria)
Returns a set of mobs from this content storage according to a given search criteria. |
boolean |
isEssenceDataPresent(MobID fileMobId)
Returns true if essence data identified by the given
mob id is contained in this content storage. |
EssenceData |
lookupEssenceData(MobID mobId)
Looks up and returns an essence data item stored in this content storage that matches the given mob id. |
Mob |
lookupMob(MobID mobId)
Returns the mob that matches the given mob id from the set of mobs in this content storage. |
void |
removeEssenceData(EssenceData essenceData)
Removes the given essence data item from the set stored in this content storage. |
void |
removeMob(Mob mob)
Removes the given mob from the set stored in this content storage. |
Methods inherited from interface tv.amwa.maj.iface.InterchangeObject |
---|
countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue |
Method Detail |
---|
Mob lookupMob(MobID mobId) throws NullPointerException, MobNotFoundException
Returns the mob that matches the given mob id from the set of mobs in this content storage.
mobId
- The identifier of the mob to find in this content storage.
NullPointerException
- The given mob identifier is null
.
MobNotFoundException
- The requested mob is not stored in this content storage.@NumSlots int countMobs(MobKind mobKind) throws NullPointerException
Find the number of matches for the given mob kind stored in this content storage.
mobKind
- The kind of mob to count.
NullPointerException
- The given mob kind is null
.Set<? extends Mob> getMobs(SearchCriteria searchCriteria)
Returns a set of mobs from this content storage according
to a given search criteria. If the
search criteria is null
then all of the mobs in storage are returned.
searchCriteria
- Search criteria to filter the set of stored mobs of this content
storage with.
SearchCriteria
,
Header.getMobs(SearchCriteria)
void addMob(Mob mob) throws NullPointerException, DuplicateMobIDException
Adds the given mob to the set of mobs in this content storage.
mob
- Mob to add to this content storage.
NullPointerException
- The given mob is null
.
DuplicateMobIDException
- The given mob is already contained in this content
storage.void removeMob(Mob mob) throws NullPointerException, MobNotFoundException
Removes the given mob from the set stored in this content storage.
mob
- Mob to remove from this content storage.
NullPointerException
- The given mob to remove is null
.
MobNotFoundException
- The given mob is not current contained in this content storage.@UInt32 int countEssenceData()
Returns the total number of essence data items in this content storage.
@Bool boolean isEssenceDataPresent(MobID fileMobId) throws NullPointerException
Returns true
if essence data identified by the given
mob id is contained in this content storage.
fileMobId
- Identifier of the essence data to check for within this content storage.
NullPointerException
- One or more of the arguments in null.Set<? extends EssenceData> enumEssenceData()
Returns the complete set of essence data contained within this content storage object.
Calling this method produces the same result as calling getEssenceData(CriteriaType.AnyRepresentation)
.
Header.enumEssenceData()
Set<? extends EssenceData> getEssenceData(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.
enumEssenceData()
,
Header.getEssenceData(CriteriaType)
void addEssenceData(EssenceData essenceData) throws DuplicateMobIDException, 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.
DuplicateMobIDException
- The given mob has already been added.
The validation is done by comparing mob ids, which should be unique amongst all essence
data in a content storage unit.
NullPointerException
- The given essence data item is null
.EssenceData.getFileMobID()
void removeEssenceData(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 lookupEssenceData(MobID mobId) throws NullPointerException, MobNotFoundException
Looks up and returns an essence data item stored in this content storage that matches the given mob id.
mobId
- The mob id identifying the essence data stored in this content storage.
NullPointerException
- The given essece data mob id is null
.
MobNotFoundException
- The requested essence data was not found stored in this content
storage.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |