com.netflix.imflibrary.writerTools

Class RegXMLLibHelper

java.lang.Object

com.netflix.imflibrary.writerTools.RegXMLLibHelper

public final class RegXMLLibHelper
extends java.lang.Object

A utility class that provides the methods to obtain a RegXML representation of a MXF metadata set

Constructor Summary

Constructors

Constructor and Description
RegXMLLibHelper(KLVPacket.Header primerPack, ByteProvider primerPackByteProvider) Constructor for the RegXMLLibHelper

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.DocumentFragment	getDocumentFragment(com.sandflow.smpte.klv.Triplet triplet, org.w3c.dom.Document document) A utility method that provides an XML Document fragment representing an MXF KLV triplet
org.w3c.dom.DocumentFragment	getEssenceDescriptorDocumentFragment(com.sandflow.smpte.klv.Triplet essenceDescriptorTriplet, java.util.List<com.sandflow.smpte.klv.Triplet> subDescriptorTriplets, org.w3c.dom.Document document) A utility method that provides an XML Document fragment representing an Essence Descriptor in the MXF file
com.sandflow.smpte.klv.MemoryTriplet	getTripletFromKLVHeader(KLVPacket.Header header, ByteProvider byteProvider) A utility method that provides an in-memory triplet representing an MXF KLV packet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegXMLLibHelper

public RegXMLLibHelper(KLVPacket.Header primerPack,
                       ByteProvider primerPackByteProvider)
                throws java.io.IOException

Constructor for the RegXMLLibHelper

Parameters:

primerPack - the Triplet representing the primer pack

primerPackByteProvider - the data provider for the primer pack

Throws:

java.io.IOException - - any I/O related error will be exposed through an IOException

Method Detail

getDocumentFragment

public org.w3c.dom.DocumentFragment getDocumentFragment(com.sandflow.smpte.klv.Triplet triplet,
                                                        org.w3c.dom.Document document)
                                                 throws MXFException

A utility method that provides an XML Document fragment representing an MXF KLV triplet

Parameters:

triplet - the KLV triplet that needs to be serialized to an XML document fragment

document - the XML document that the document fragment is associated with

Returns:

An XML DOM DocumentFragment

Throws:

MXFException - if any error occurs while trying to create the document fragment

getEssenceDescriptorDocumentFragment

public org.w3c.dom.DocumentFragment getEssenceDescriptorDocumentFragment(com.sandflow.smpte.klv.Triplet essenceDescriptorTriplet,
                                                                         java.util.List<com.sandflow.smpte.klv.Triplet> subDescriptorTriplets,
                                                                         org.w3c.dom.Document document)
                                                                  throws MXFException

A utility method that provides an XML Document fragment representing an Essence Descriptor in the MXF file

Parameters:

essenceDescriptorTriplet - - a KLV triplet corresponding to an Essence Descriptor

document - an XML document

subDescriptorTriplets - list of triplets corresponding to the subdescriptors referred by the essenceDescriptor

Returns:

An XML DOM DocumentFragment

Throws:

MXFException - if any error occurs while trying to create the document fragment

getTripletFromKLVHeader

public com.sandflow.smpte.klv.MemoryTriplet getTripletFromKLVHeader(KLVPacket.Header header,
                                                                    ByteProvider byteProvider)
                                                             throws java.io.IOException

A utility method that provides an in-memory triplet representing an MXF KLV packet

Parameters:

header - - the MXF KLV header corresponding to an MXF KLV packet

byteProvider - - data provider for the MXF KLV packet

Returns:

A memory triplet representing the MXF KLV packet

Throws:

java.io.IOException - - any I/O related error will be exposed through an IOException