edu.isi.pegasus.planner.dax

Class File

java.lang.Object

edu.isi.pegasus.planner.dax.CatalogType

edu.isi.pegasus.planner.dax.File

public class File
extends CatalogType

This class is the container for any File object, either the RC section, or uses

Version:

$Revision$

Author:

gmehta

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	File.LINK The linkages that a file can be of
static class	File.TRANSFER Three Transfer modes supported, Transfer this file, don't transfer or stageout as well as optional.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mExecutable Is the file an executable.
protected File.LINK	mLink
protected String	mName The logical name of the file.
protected String	mNamespace The namespace on a file.
protected boolean	mOptional Is the file optional
protected boolean	mRegister Should the file be registered in the replica catalog
protected String	mSize File size of the file no units required
protected File.TRANSFER	mTransfer Should the file be transferred on generation.
protected String	mVersion The logical version of the file.

Fields inherited from class edu.isi.pegasus.planner.dax.CatalogType

mLogger, mMetadata, mPFNs, mProfiles

Constructor Summary

Constructors

Constructor and Description
File(File f) Copy constructor
File(File f, File.LINK link) Copy constructor, but change the linkage of the file.
File(String name) Create new file object
File(String name, File.LINK link) Create new file object
File(String namespace, String name, String version) Create new File object
File(String namespace, String name, String version, File.LINK link) Create a new file object

Method Summary

Modifier and Type	Method and Description
File	clone() Return a clone of this File
boolean	equals(Object o) Check if this File is equal to Object o
boolean	getExecutable() Check if the file is an executable
File.LINK	getLink() Get the linkage of the file.
String	getName() Get the name of the file
String	getNamespace() Get the namespace of the file
boolean	getOptional() Check the optional flag of the file
boolean	getRegister() Get the register flag of this file.
String	getSize() Return the size of the file
File.TRANSFER	getTransfer() Get the transfer type of the file
String	getVersion() Get the version of the file
int	hashCode() HashCode of this File
boolean	isFile()
File	setExecutable() Mark the file as executable.
File	setExecutable(boolean executable) Mark the file as executable.
File	setLink(File.LINK link) Set the file linkage
File	setOptional(boolean optionalflag) Set the optional flag on the file.
File	setRegister(boolean registerflag) Set the register flag of the file.
File	setSize(String size) Set the size of the file.
File	setTransfer(File.TRANSFER transferflag) Set the transfer type of the file
void	toXML(edu.isi.pegasus.common.util.XMLWriter writer) Write the file object
void	toXML(edu.isi.pegasus.common.util.XMLWriter writer, int indent) Write the file object, with indent level N
void	toXML(edu.isi.pegasus.common.util.XMLWriter writer, int indent, String elementname) Write the file object as XML but render it as the elementname

Methods inherited from class edu.isi.pegasus.planner.dax.CatalogType

addMetaData, addMetaData, addMetaData, addPhysicalFile, addPhysicalFile, addPhysicalFile, addPhysicalFiles, addProfile, addProfile, addProfiles, addProfiles, getMetaData, getPhysicalFiles, getProfiles, isExecutable

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

mNamespace

protected String mNamespace

The namespace on a file. This is used for Executables only

mName

protected String mName

The logical name of the file.

mVersion

protected String mVersion

The logical version of the file. This is used for executables only.

mLink

protected File.LINK mLink

mOptional

protected boolean mOptional

Is the file optional

mRegister

protected boolean mRegister

Should the file be registered in the replica catalog

mTransfer

protected File.TRANSFER mTransfer

Should the file be transferred on generation.

mExecutable

protected boolean mExecutable

Is the file an executable.

mSize

protected String mSize

File size of the file no units required

Constructor Detail

File

public File(String name)

Create new file object

Parameters:

name - The name of the file

File

public File(String name,
            File.LINK link)

Create new file object

Parameters:

name - The name of the file

link - The linkage of the file

File

public File(File f)

Copy constructor

Parameters:

f - File

File

public File(File f,
            File.LINK link)

Copy constructor, but change the linkage of the file.

Parameters:

f - File

link - Link

File

public File(String namespace,
            String name,
            String version)

Create new File object

Parameters:

namespace -

name -

version -

File

public File(String namespace,
            String name,
            String version,
            File.LINK link)

Create a new file object

Parameters:

namespace - The namespace of the file

name - The name of the file

version - The version of the file

link - The linkage of the file.

Method Detail

getName

public String getName()

Get the name of the file

Returns:

getNamespace

public String getNamespace()

Get the namespace of the file

Returns:

getVersion

public String getVersion()

Get the version of the file

Returns:

getLink

public File.LINK getLink()

Get the linkage of the file.

Returns:

setLink

public File setLink(File.LINK link)

Set the file linkage

Parameters:

link -

Returns:

See Also:

File.LINK

setOptional

public File setOptional(boolean optionalflag)

Set the optional flag on the file. Default is false

Parameters:

optionalflag -

Returns:

getOptional

public boolean getOptional()

Check the optional flag of the file

Returns:

setRegister

public File setRegister(boolean registerflag)

Set the register flag of the file. Default is true

Parameters:

registerflag -

Returns:

getRegister

public boolean getRegister()

Get the register flag of this file.

Returns:

setTransfer

public File setTransfer(File.TRANSFER transferflag)

Set the transfer type of the file

Parameters:

transferflag -

Returns:

See Also:

File.TRANSFER

getTransfer

public File.TRANSFER getTransfer()

Get the transfer type of the file

Returns:

setExecutable

public File setExecutable(boolean executable)

Mark the file as executable. Default is false

Parameters:

executable -

Returns:

setExecutable

public File setExecutable()

Mark the file as executable. Default is false

Returns:

getExecutable

public boolean getExecutable()

Check if the file is an executable

Returns:

setSize

public File setSize(String size)

Set the size of the file.

Parameters:

size -

Returns:

getSize

public String getSize()

Return the size of the file

Returns:

empty string if no size defined, otherwise returns the size

isFile

public boolean isFile()

Overrides:

isFile in class CatalogType

equals

public boolean equals(Object o)

Check if this File is equal to Object o

Overrides:

equals in class Object

Parameters:

o -

Returns:

hashCode

public int hashCode()

HashCode of this File

Overrides:

hashCode in class Object

Returns:

clone

public File clone()

Return a clone of this File

Overrides:

clone in class Object

Returns:

toXML

public void toXML(edu.isi.pegasus.common.util.XMLWriter writer)

Write the file object

Overrides:

toXML in class CatalogType

Parameters:

writer -

See Also:

XMLWriter

toXML

public void toXML(edu.isi.pegasus.common.util.XMLWriter writer,
                  int indent)

Write the file object, with indent level N

Overrides:

toXML in class CatalogType

Parameters:

writer -

indent -

See Also:

XMLwriter

toXML

public void toXML(edu.isi.pegasus.common.util.XMLWriter writer,
                  int indent,
                  String elementname)

Write the file object as XML but render it as the elementname

Parameters:

writer -

indent -

elementname -