viper.descriptors
Class CanonicalFileDescriptor

java.lang.Object
  viper.descriptors.CanonicalFileDescriptor

All Implemented Interfaces:

java.lang.Cloneable

public class CanonicalFileDescriptor

extends java.lang.Object

implements java.lang.Cloneable

This class holds a FILE Information descriptor and can perform some standard operations. Each element can have its own cfd. A cfd contains such information as frame size, number of frames, and file names.

Constructor Summary

CanonicalFileDescriptor()
Constructs a new canonical file descriptor from the static prototype.

CanonicalFileDescriptor(DescPrototype proto)
Constructs a new canonical file descriptor from the given prototype.

Method Summary

void	add(CanonicalFileDescriptor other) Merges the given cfd with this cfd.
void	clear() Clears the cfd value.
java.lang.Object	clone()
Descriptor	getDescriptor() Gets the instance of the file descriptor.
int[]	getDimensions() Gets the x/y dimension.
java.lang.String	getMediaType() Gets the media type of the video.
int	getNumFrames() Gets the number of frames in the video.
static DescPrototype	getPrototype() Gets a copy of the prototype for a canonical file descriptor.
java.lang.String	getSourceDirectory() Gets the source directory attribute value.
java.util.Set	getSourceDirectorySet() Gets the source directories.
java.lang.String	getSourceFiles() Gets the list of source media files.
DescPrototype	getThisPrototype() Gets a copy of this file descriptor, which may have more attributes than the static prototype file descriptor.
java.lang.String	set(Descriptor cfd) Sets the canonical file descriptor to the given FILE Information descriptor
java.lang.String	set(Descriptor cfd, boolean fixSourcefileThatStartAt0) Sets the canonical file descriptor to the given FILE Information descriptor
void	setDimensions(int width, int height) Sets the dimensions
void	setID(int id) Sets the identification number of the underlying descriptor.
void	setMediaType(java.lang.String mediaType) Sets the media type of the video.
void	setNumFrames(int numberOfFramesInClip) Sets the number of frames in the video.
void	setSourceDirectory(java.lang.String sourceDir) Sets the source directory attribute value.
void	setSourceDirectorySet(java.util.Set dirs) Sets the source directories.
void	setSourceFiles(java.lang.String sourceFiles) Sets the list of source media files.

Methods inherited from class java.lang.Object

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

Constructor Detail

CanonicalFileDescriptor

public CanonicalFileDescriptor()

Constructs a new canonical file descriptor from the static prototype.

CanonicalFileDescriptor

public CanonicalFileDescriptor(DescPrototype proto)

Constructs a new canonical file descriptor from the given prototype.

Parameters:

proto - the prototype to use. This will be modified to contain all of the prototypical file descriptor attributes.

Method Detail

getPrototype

public static final DescPrototype getPrototype()

Gets a copy of the prototype for a canonical file descriptor.

Returns:

the file descriptor

getThisPrototype

public DescPrototype getThisPrototype()

Gets a copy of this file descriptor, which may have more attributes than the static prototype file descriptor.

Returns:

a copy of the user enhanced canonical file descriptor

clone

public java.lang.Object clone()

getDescriptor

public Descriptor getDescriptor()

Gets the instance of the file descriptor.

Returns:

the file descriptor

add

public void add(CanonicalFileDescriptor other)

Merges the given cfd with this cfd. Note that SOURCEFILES does not change.

Parameters:

other - the cfd to add to this cfd

setID

public void setID(int id)

Sets the identification number of the underlying descriptor.

Parameters:

id - the new ID number

getNumFrames

public int getNumFrames()

Gets the number of frames in the video.

Returns:

the number of frames, according to the file descriptor

setNumFrames

public void setNumFrames(int numberOfFramesInClip)

Sets the number of frames in the video.

Parameters:

numberOfFramesInClip - the new number of frames

getMediaType

public java.lang.String getMediaType()

Gets the media type of the video.

Returns:

the media type, according to the file descriptor

setMediaType

public void setMediaType(java.lang.String mediaType)

Sets the media type of the video.

Parameters:

mediaType - the new media type

getSourceFiles

public java.lang.String getSourceFiles()

Gets the list of source media files.

Returns:

the list of source media files, according to the file descriptor

setSourceFiles

public void setSourceFiles(java.lang.String sourceFiles)

Sets the list of source media files.

Parameters:

sourceFiles - the new list of source media files

getSourceDirectorySet

public java.util.Set getSourceDirectorySet()

Gets the source directories.

Returns:

the source directories

setSourceDirectorySet

public void setSourceDirectorySet(java.util.Set dirs)

Sets the source directories.

Parameters:

dirs - the directories containing the files named in the sourcefiles attribute

getSourceDirectory

public java.lang.String getSourceDirectory()

Gets the source directory attribute value.

Returns:

the source directory

setSourceDirectory

public void setSourceDirectory(java.lang.String sourceDir)

Sets the source directory attribute value.

Parameters:

sourceDir - the new source directory

getDimensions

public int[] getDimensions()

Gets the x/y dimension.

Returns:

the dimensions, in x/y

setDimensions

public void setDimensions(int width,
                          int height)

Sets the dimensions

Parameters:

width - the new width

height - the new height

clear

public void clear()

Clears the cfd value.

set

public java.lang.String set(Descriptor cfd)

Sets the canonical file descriptor to the given FILE Information descriptor

Parameters:

cfd - the new descriptor

Returns:

a list of errors in the descriptor format.

set

public java.lang.String set(Descriptor cfd,
                            boolean fixSourcefileThatStartAt0)

Sets the canonical file descriptor to the given FILE Information descriptor

Parameters:

cfd - the new descriptor

fixSourcefileThatStartAt0 - When true, if the SOUCEFILES attribute starts at frame 0, add one to all numbers in the string.

Returns:

a list of errors in the descriptor format.