HeaderPartition

java.lang.Object
- com.netflix.imflibrary.st0377.HeaderPartition

```
@Immutable
public final class HeaderPartition
extends java.lang.Object
```
This class corresponds to an object model for the Header Partition construct defined in st377-1:2011

Constructor Summary

Constructors
Constructor and Description
`HeaderPartition(ByteProvider byteProvider, long byteOffset, long maxPartitionSize, IMFErrorLogger imfErrorLogger)` Instantiates a new MXF Header partition.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<InterchangeObject>`	`getAudioChannelLabelSubDescriptors()` Gets all the audio channel label sub descriptors associated with this HeaderPartition object
`java.util.List<InterchangeObject>`	`getContentStorageList()` Gets all of the ContentStorage objects corresponding to this HeaderPartition object
`EssenceContainerData`	`getEssenceContainerData(MXFUID MXFUID)` Gets the EssenceContainerData object associated with this HeaderPartition object corresponding to the specified UID.
`java.util.List<InterchangeObject>`	`getEssenceContainerDataList()` Gets all of the EssenceContainerData objects corresponding to this HeaderPartition object
`java.util.List<InterchangeObject.InterchangeObjectBO>`	`getEssenceDescriptors()` Gets all of the EssenceDescriptor objects corresponding to this HeaderPartition object that are referenced by the Source Packages in this header partition
`java.math.BigInteger`	`getEssenceDuration()` Returns the largest duration of all the TimelineTracks within the first (in parsing order) Material Package associated with this HeaderPartition object
`MaterialPackage`	`getMaterialPackage(MXFUID MXFUID)` Gets the MaterialPackage object associated with this HeaderPartition object corresponding to the specified UID.
`java.util.List<InterchangeObject>`	`getMaterialPackages()` Gets all of the MaterialPackage objects corresponding to this HeaderPartition object
`PartitionPack`	`getPartitionPack()` Gets the partition pack corresponding to this HeaderPartition
`Preface`	`getPreface()` Gets the Preface object corresponding to this HeaderPartition object
`PrimerPack`	`getPrimerPack()` Gets the PrimerPack object corresponding to this HeaderPartition object
`Sequence`	`getSequence(MXFUID MXFUID)` Gets the Sequence object associated with this HeaderPartition object corresponding to the specified UID.
`java.util.List<InterchangeObject>`	`getSoundFieldGroupLabelSubDescriptors()` Gets all the sound field group label sub descriptors associated with this HeaderPartition object
`SourceClip`	`getSourceClip(MXFUID MXFUID)` Gets the SourceClip object associated with this HeaderPartition object corresponding to the specified UID.
`SourcePackage`	`getSourcePackage(MXFUID MXFUID)` Gets the SourcePackage object associated with this HeaderPartition object corresponding to the specified UID.
`java.util.List<InterchangeObject>`	`getSourcePackages()` Gets all of the SourcePackage objects corresponding to this HeaderPartition object
`java.util.List<InterchangeObject.InterchangeObjectBO>`	`getStructuralMetadata(StructuralMetadataID structuralMetadataID)` Getter for a parsed InterchangeObject by ID
`java.util.List<InterchangeObject.InterchangeObjectBO>`	`getSubDescriptors()` Gets all of the SubDescriptor objects corresponding to this HeaderPartition object that are referenced by all the source packages in this header partition
`java.util.List<InterchangeObject.InterchangeObjectBO>`	`getSubDescriptors(InterchangeObject.InterchangeObjectBO essenceDescriptor)` Gets the SubDescriptor objects corresponding to this HeaderPartition object that are referred by the specified EssenceDescriptor
`TimelineTrack`	`getTimelineTrack(MXFUID MXFUID)` Gets the timeline track associated with this HeaderPartition object corresponding to the specified UID.
`java.util.List<InterchangeObject>`	`getWaveAudioEssenceDescriptors()` Gets all the wave audio essence descriptors associated with this HeaderPartition object
`boolean`	`hasAudioChannelLabelSubDescriptors()` Checks if this HeaderPartition object has any audio channel label sub descriptors
`boolean`	`hasCDCIPictureEssenceDescriptor()` Checks if this HeaderPartition object has a CDCI Picture Essence Descriptor
`boolean`	`hasPHDRMetaDataTrackSubDescriptor()` Checks if this HeaderPartition object has a PHDR Metadata track SubDescriptor
`boolean`	`hasRGBAPictureEssenceDescriptor()` Checks if this HeaderPartition object has a RGBA Picture Essence Descriptor
`boolean`	`hasSoundFieldGroupLabelSubDescriptor()` Checks if this HeaderPartition object has any sound field group label sub descriptors
`boolean`	`hasWaveAudioEssenceDescriptor()` Checks if this HeaderPartition object has a Wave Audio Essence Descriptor
`java.lang.String`	`toString()` A method that returns a string representation of a HeaderPartition object

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HeaderPartition
```
public HeaderPartition(ByteProvider byteProvider,
                       long byteOffset,
                       long maxPartitionSize,
                       IMFErrorLogger imfErrorLogger)
                throws java.io.IOException
```
    Instantiates a new MXF Header partition.
    
    Parameters:
    
    byteProvider - the input sequence of bytes
    
    byteOffset - the byte offset corresponding to the HeaderPartition
    
    maxPartitionSize - the size of the header partition
    
    imfErrorLogger - an IMFErrorLogger dedicated to this header partition
    
    Throws:
    
    java.io.IOException - - any I/O related error will be exposed through an IOException
- Method Detail
  - getPreface
```
@Nullable
public Preface getPreface()
```
    Gets the Preface object corresponding to this HeaderPartition object
    
    Returns:
    
    the Preface object in this HeaderPartition
  - getPrimerPack
```
@Nullable
public PrimerPack getPrimerPack()
```
    Gets the PrimerPack object corresponding to this HeaderPartition object
    
    Returns:
    
    the PrimerPack object in this HeaderPartition
  - getContentStorageList
```
public java.util.List<InterchangeObject> getContentStorageList()
```
    Gets all of the ContentStorage objects corresponding to this HeaderPartition object
    
    Returns:
    
    list of ContentStorage objects in this HeaderPartition
  - getMaterialPackages
```
public java.util.List<InterchangeObject> getMaterialPackages()
```
    Gets all of the MaterialPackage objects corresponding to this HeaderPartition object
    
    Returns:
    
    list of MaterialPackage objects in this HeaderPartition
  - getEssenceContainerDataList
```
public java.util.List<InterchangeObject> getEssenceContainerDataList()
```
    Gets all of the EssenceContainerData objects corresponding to this HeaderPartition object
    
    Returns:
    
    list of EssenceContainerData objects in this HeaderPartition
  - getSourcePackages
```
public java.util.List<InterchangeObject> getSourcePackages()
```
    Gets all of the SourcePackage objects corresponding to this HeaderPartition object
    
    Returns:
    
    list of SourcePackages in this HeaderPartition
  - getEssenceDescriptors
```
public java.util.List<InterchangeObject.InterchangeObjectBO> getEssenceDescriptors()
```
    Gets all of the EssenceDescriptor objects corresponding to this HeaderPartition object that are referenced by the Source Packages in this header partition
    
    Returns:
    
    list of EssenceDescriptor objects referenced by the Source Packages in this HeaderPartition
  - getSubDescriptors
```
public java.util.List<InterchangeObject.InterchangeObjectBO> getSubDescriptors()
```
    Gets all of the SubDescriptor objects corresponding to this HeaderPartition object that are referenced by all the source packages in this header partition
    
    Returns:
    
    list of SubDescriptor objects referenced by the Source Packages in this HeaderPartition
  - getSubDescriptors
```
public java.util.List<InterchangeObject.InterchangeObjectBO> getSubDescriptors(InterchangeObject.InterchangeObjectBO essenceDescriptor)
```
    Gets the SubDescriptor objects corresponding to this HeaderPartition object that are referred by the specified EssenceDescriptor
    
    Parameters:
    
    essenceDescriptor - the essence descriptor whose referred subdescriptors are requested
    
    Returns:
    
    list of SubDescriptor objects referenced by the Essence Descriptors in this HeaderPartition
  - getEssenceDuration
```
public java.math.BigInteger getEssenceDuration()
```
    Returns the largest duration of all the TimelineTracks within the first (in parsing order) Material Package associated with this HeaderPartition object
    
    Returns:
    
    the largest duration of all the Timeline tracks within the first Material Package associated with this Header partition
  - getStructuralMetadata
```
public java.util.List<InterchangeObject.InterchangeObjectBO> getStructuralMetadata(StructuralMetadataID structuralMetadataID)
```
    Getter for a parsed InterchangeObject by ID
    
    Parameters:
    
    structuralMetadataID - identifier for the structural metadata set
    
    Returns:
    
    the InterchangeObjectBO corresponding to the class name
  - hasWaveAudioEssenceDescriptor
```
public boolean hasWaveAudioEssenceDescriptor()
```
    Checks if this HeaderPartition object has a Wave Audio Essence Descriptor
    
    Returns:
    
    true/false depending on whether this HeaderPartition contains a WaveAudioEssenceDescriptor or not
  - hasCDCIPictureEssenceDescriptor
```
public boolean hasCDCIPictureEssenceDescriptor()
```
    Checks if this HeaderPartition object has a CDCI Picture Essence Descriptor
    
    Returns:
    
    true/false depending on whether this HeaderPartition contains a CDCIPictureEssenceDescriptor or not
  - hasRGBAPictureEssenceDescriptor
```
public boolean hasRGBAPictureEssenceDescriptor()
```
    Checks if this HeaderPartition object has a RGBA Picture Essence Descriptor
    
    Returns:
    
    true/false depending on whether this HeaderPartition contains a RGBAPictureEssenceDescriptor or not
  - hasPHDRMetaDataTrackSubDescriptor
```
public boolean hasPHDRMetaDataTrackSubDescriptor()
```
    Checks if this HeaderPartition object has a PHDR Metadata track SubDescriptor
    
    Returns:
    
    true/false depending on whether this HeaderPartition contains a PHDRMetaDataTrackSubDescriptor or not
  - getWaveAudioEssenceDescriptors
```
public java.util.List<InterchangeObject> getWaveAudioEssenceDescriptors()
```
    Gets all the wave audio essence descriptors associated with this HeaderPartition object
    
    Returns:
    
    list of all the WaveAudioEssenceDescriptors in this header partition
  - hasAudioChannelLabelSubDescriptors
```
public boolean hasAudioChannelLabelSubDescriptors()
```
    Checks if this HeaderPartition object has any audio channel label sub descriptors
    
    Returns:
    
    true/false depending on whether this HeaderPartition contains an AudioChannelLabelSubDescriptor or not
  - getAudioChannelLabelSubDescriptors
```
public java.util.List<InterchangeObject> getAudioChannelLabelSubDescriptors()
```
    Gets all the audio channel label sub descriptors associated with this HeaderPartition object
    
    Returns:
    
    list of audio channel label sub descriptors contained in this header partition
  - hasSoundFieldGroupLabelSubDescriptor
```
public boolean hasSoundFieldGroupLabelSubDescriptor()
```
    Checks if this HeaderPartition object has any sound field group label sub descriptors
    
    Returns:
    
    true/false depending on whether this HeaderPartition contains a SoundFieldGroupLabelSubDescriptor or not
  - getSoundFieldGroupLabelSubDescriptors
```
public java.util.List<InterchangeObject> getSoundFieldGroupLabelSubDescriptors()
```
    Gets all the sound field group label sub descriptors associated with this HeaderPartition object
    
    Returns:
    
    list of sound field group label sub descriptors contained in this header partition
  - getTimelineTrack
```
@Nullable
public TimelineTrack getTimelineTrack(MXFUID MXFUID)
```
    Gets the timeline track associated with this HeaderPartition object corresponding to the specified UID. Returns null if none is found
    
    Parameters:
    
    MXFUID - corresponding to the Timeline Track
    
    Returns:
    
    null if this header partition does not contain a timeline track, else a timeline track object
  - getSequence
```
@Nullable
public Sequence getSequence(MXFUID MXFUID)
```
    Gets the Sequence object associated with this HeaderPartition object corresponding to the specified UID. Returns null if none is found
    
    Parameters:
    
    MXFUID - corresponding to the Sequence
    
    Returns:
    
    null if this header partition does not contain a sequence, else a sequence object
  - getSourceClip
```
@Nullable
public SourceClip getSourceClip(MXFUID MXFUID)
```
    Gets the SourceClip object associated with this HeaderPartition object corresponding to the specified UID. Returns null if none is found
    
    Parameters:
    
    MXFUID - corresponding to the Source Clip
    
    Returns:
    
    null if this header partition does not contain a source clip, else a source clip object
  - getMaterialPackage
```
@Nullable
public MaterialPackage getMaterialPackage(MXFUID MXFUID)
```
    Gets the MaterialPackage object associated with this HeaderPartition object corresponding to the specified UID. Returns null if none is found
    
    Parameters:
    
    MXFUID - corresponding to the Material Package
    
    Returns:
    
    null if this header partition does not contain a material package, else a material package object
  - getSourcePackage
```
@Nullable
public SourcePackage getSourcePackage(MXFUID MXFUID)
```
    Gets the SourcePackage object associated with this HeaderPartition object corresponding to the specified UID. Returns null if none is found
    
    Parameters:
    
    MXFUID - corresponding to the Source Package
    
    Returns:
    
    null if this header partition does not contain a source package, else a source package object
  - getEssenceContainerData
```
@Nullable
public EssenceContainerData getEssenceContainerData(MXFUID MXFUID)
```
    Gets the EssenceContainerData object associated with this HeaderPartition object corresponding to the specified UID. Returns null if none is found
    
    Parameters:
    
    MXFUID - corresponding to the EssenceContainerData
    
    Returns:
    
    null if this header partition does not contain an EssenceContainerData object, else a EssenceContainerData object
  - getPartitionPack
```
public PartitionPack getPartitionPack()
```
    Gets the partition pack corresponding to this HeaderPartition
    
    Returns:
    
    the partition pack object corresponding to this HeaderPartition
  - toString
```
public java.lang.String toString()
```
    A method that returns a string representation of a HeaderPartition object
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    string representing the object

Class HeaderPartition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HeaderPartition

Method Detail

getPreface

getPrimerPack

getContentStorageList

getMaterialPackages

getEssenceContainerDataList

getSourcePackages

getEssenceDescriptors

getSubDescriptors

getSubDescriptors

getEssenceDuration

getStructuralMetadata

hasWaveAudioEssenceDescriptor

hasCDCIPictureEssenceDescriptor

hasRGBAPictureEssenceDescriptor

hasPHDRMetaDataTrackSubDescriptor

getWaveAudioEssenceDescriptors

hasAudioChannelLabelSubDescriptors

getAudioChannelLabelSubDescriptors

hasSoundFieldGroupLabelSubDescriptor

getSoundFieldGroupLabelSubDescriptors

getTimelineTrack

getSequence

getSourceClip

getMaterialPackage

getSourcePackage

getEssenceContainerData

getPartitionPack

toString