Media Authoring
with Java API

tv.amwa.maj.argument
Class FindSourceInformation

java.lang.Object
  extended by tv.amwa.maj.argument.FindSourceInformation
All Implemented Interfaces:
Serializable, Cloneable, FindSourceInformation

public class FindSourceInformation
extends Object
implements FindSourceInformation, Serializable, Cloneable

Implementation of a class that contains the result returned by the SearchSource.searchSource(int, long, tv.amwa.maj.enumeration.MobKind, tv.amwa.maj.enumeration.CriteriaType, tv.amwa.maj.enumeration.OperationChoice) method, containing source information about particular mob slots.

The information available in this object will depend on the kind of search carried out. All methods in this interface that return a non-primitive type value could return a null pointer to indicate that a value is not present.

Author:
Richard Cartwright
See Also:
Serialized Form

Constructor Summary
FindSourceInformation(Mob mob, Integer slotId, Long position, Rational editRate, Long length, Component component)
           
 
Method Summary
 Rational getEditRate()
          Returns the edit rate for the search result.
 long getLength()
          Returns the length of this component.
 Mob getMob()
          Returns the mob search result.
 SourceReferenceValue getSourceReference()
          Returns the source reference search result.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FindSourceInformation

public FindSourceInformation(Mob mob,
                             Integer slotId,
                             Long position,
                             Rational editRate,
                             Long length,
                             Component component)
Method Detail

getEditRate

public Rational getEditRate()
Description copied from interface: FindSourceInformation

Returns the edit rate for the search result.

Specified by:
getEditRate in interface FindSourceInformation
Returns:
Edit rate for the search result, or null if this value is not available.

getLength

public long getLength()
               throws BadPropertyException
Description copied from interface: FindSourceInformation

Returns the length of this component. The duration is specified in edit units of the result.

This method deals with an optional property, which will only be present for time-varying media and some events.

Specified by:
getLength in interface FindSourceInformation
Returns:
Length of the component.
Throws:
BadPropertyException - The optional length property is not present for this object.

getMob

public Mob getMob()
Description copied from interface: FindSourceInformation

Returns the mob search result.

Specified by:
getMob in interface FindSourceInformation
Returns:
The final media object referenced, or null if no valid mob is referenced.

getSourceReference

public SourceReferenceValue getSourceReference()
Description copied from interface: FindSourceInformation

Returns the source reference search result.

Specified by:
getSourceReference in interface FindSourceInformation
Returns:
Source reference search result, or null if the value is not available.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.