| org.griphyn.vdl.dax.DAX
 org.griphyn.vdl.dax.Leaf
org.griphyn.vdl.dax.Filename
| Filename | | public class Filename extends Leaf implements Cloneable(Code) | | This class captures the logical filename and its linkage. Also,
some static methods allow to use the linkage constants outside
the class.
Filename extends the Leaf class by adding a
filename, linkage type, temporary pattern, and management attributes.
author:
Jens-S. Vöckler
author:
Yong Zhao
version:
$Revision: 366 $
See Also: Leaf
See Also: PseudoText |
| Constructor Summary | |
| public | Filename()
Default ctor: create a hollow instance which needs to be filled
with content. | | public | Filename(String filename)
Default ctor: create an instance with a logical filename. | | public | Filename(String filename, int link)
ctor: create a file with a name and linkage. | | public | Filename(String filename, int link, String hint)
ctor: create a transient file with a name, linkage and hint.
Parameters:
filename - is the logical filename to store.
Parameters:
link - is the linkage of the file to remember.
Parameters:
hint - is the transient filename. | | public | Filename(String filename, int link, String hint, boolean dontRegister, int dontTransfer, String variable)
ctor: Creates a filename given all specs. | | public | Filename(String filename, int link, String hint, boolean dontRegister, int dontTransfer, String variable, boolean optional)
ctor: Creates a filename given all specs. | | public | Filename(LFN lfn)
convenience ctor: create a DAX filename from a VDLx filename. |
| Method Summary | |
| public Object | clone()
Creates and returns a copy of this object. | | public boolean | getDontRegister()
Accessor: Obtains the predicate on registring with a replica
catalog. | | public int | getDontTransfer()
Accessor: Obtains the transfer mode. | | public String | getFilename()
Accessor: Obtains the logical filename for this instance. | | public int | getLink()
Accessor: Obtains the linkage type from the object.
the linkage type of the current object. | | public boolean | getOptional()
Acessor: Obtains the optionality of the file. | | public boolean | getRegister()
Accessor: Obtains the predicate on registring with a replica
catalog. | | public String | getTemporary()
Accessor: Obtains the file name suggestion for a transient file.
If a filename is marked transient, the higher level planners might
have some notion where to place it, or how to name it. | | public int | getTransfer()
Accessor: Obtains the transfering mode. | | public int | getType()
| | public String | getVariable()
Accessor: Obtains the responsible variable. | | public void | setDontRegister(boolean dontRegister)
Accessor: Sets the predicate on registring with a replica catalog. | | public void | setDontTransfer(int dontTransfer)
Accessor: Sets the transfer mode. | | public void | setFilename(String name)
| | public void | setLink(int link)
Accessor: Sets the linkage type.
Parameters:
link - is the new linkage type to use. | | public void | setOptional(boolean optional)
Acessor: Sets the optionality of the file. | | public void | setRegister(boolean register)
Accessor: Sets the predicate on registring with a replica catalog. | | public void | setTemporary(String name)
Accessor: Sets a file name suggestion for a transient file. | | public void | setTransfer(int transfer)
Accessor: Sets the transfer mode. | | public void | setType(int type)
| | public void | setVariable(String variable)
Accessor: Sets the responsible variable. | | public String | shortXML(String indent, String namespace, int flag)
Dumps the state of the filename as PlainFilenameType or
StdioFilenameType without the transiency information.
Parameters:
indent - is a String of spaces used for prettyprinting. | | public void | shortXML(Writer stream, String indent, String namespace, int flag)
Dumps the state of the filename as PlainFilenameType or
StdioFilenameType without the transiency information.
Parameters:
stream - is a stream opened and ready for writing. | | public String | toString()
Convert the logical filename and linkage into something human
readable. | | public void | toString(Writer stream)
Converts the active state into something meant for human consumption.
The method will be called when recursively traversing the instance
tree.
Parameters:
stream - is a stream opened and ready for writing. | | public String | toXML(String indent, String namespace)
Dumps the state of the current element as XML output. | | public void | toXML(Writer stream, String indent, String namespace)
Dump the state of the current element as XML output. |
| Filename | | public Filename()(Code) | | Default ctor: create a hollow instance which needs to be filled
with content.
|
| Filename | | public Filename(String filename)(Code) | | Default ctor: create an instance with a logical filename. The linkage
defaults to
org.griphyn.vdl.classes.LFN.NONE .
Parameters:
filename - is the logical filename to store. |
| Filename | | public Filename(String filename, int link) throws IllegalArgumentException(Code) | | ctor: create a file with a name and linkage.
Parameters:
filename - is the logical filename to store.
Parameters:
link - is the linkage of the file to remember.
throws:
IllegalArgumentException - if the linkage does not match thelegal range. |
| Filename | | public Filename(String filename, int link, String hint) throws IllegalArgumentException(Code) | | ctor: create a transient file with a name, linkage and hint.
Parameters:
filename - is the logical filename to store.
Parameters:
link - is the linkage of the file to remember.
Parameters:
hint - is the transient filename. If null, the file is regular,if set, the file is assumed to be neither registered not transferred.
exception:
IllegalArgumentException - if the linkage does not match thelegal range. |
| Filename | | public Filename(String filename, int link, String hint, boolean dontRegister, int dontTransfer, String variable) throws IllegalArgumentException(Code) | | ctor: Creates a filename given all specs.
Parameters:
filename - is the logical filename to store.
Parameters:
link - is the linkage of the file to remember.
Parameters:
hint - is an expression for a temporary filename choice.
Parameters:
dontRegister - whether to to register with a replica catalog.
Parameters:
dontTransfer - whether to transfer the file to the collector.
Parameters:
variable - is the variable that is responsible for this LFN.
throws:
IllegalArgumentException - if the linkage does not match thelegal range, or the transfer mode does not match its legal range.
since:
1.6 |
| Filename | | public Filename(String filename, int link, String hint, boolean dontRegister, int dontTransfer, String variable, boolean optional) throws IllegalArgumentException(Code) | | ctor: Creates a filename given all specs.
Parameters:
filename - is the logical filename to store.
Parameters:
link - is the linkage of the file to remember.
Parameters:
hint - is an expression for a temporary filename choice.
Parameters:
dontRegister - whether to to register with a replica catalog.
Parameters:
dontTransfer - whether to transfer the file to the collector.
Parameters:
variable - is the variable that is responsible for this LFN.
Parameters:
optional - records the optionality of a given file.
throws:
IllegalArgumentException - if the linkage does not match thelegal range, or the transfer mode does not match its legal range.
since:
1.8 |
| Filename | | public Filename(LFN lfn) throws IllegalArgumentException(Code) | | convenience ctor: create a DAX filename from a VDLx filename.
Parameters:
lfn - is a VDLx logical filename. |
| clone | | public Object clone()(Code) | | Creates and returns a copy of this object.
a new instance. |
| getDontRegister | | public boolean getDontRegister()(Code) | | Accessor: Obtains the predicate on registring with a replica
catalog.
false if the file will be registered with a replica catalog.
See Also: Filename.getRegister()
since:
1.6 |
| getDontTransfer | | public int getDontTransfer()(Code) | | Accessor: Obtains the transfer mode.
false if the file will be tranferred to an output collector.
See Also: Filename.getTransfer()
since:
1.6 |
| getLink | | public int getLink()(Code) | | Accessor: Obtains the linkage type from the object.
the linkage type of the current object. Note thatFilename constructor defaults to no linkage.
See Also: Filename.setLink(int) |
| getOptional | | public boolean getOptional()(Code) | | Acessor: Obtains the optionality of the file.
false, if the file is required, or true, if it is optional.
See Also: Filename.setOptional(boolean)
since:
1.8 |
| getRegister | | public boolean getRegister()(Code) | | Accessor: Obtains the predicate on registring with a replica
catalog.
true if the file will be registered with a replica catalog.
See Also: Filename.setRegister(boolean)
since:
2.1 |
| getTemporary | | public String getTemporary()(Code) | | Accessor: Obtains the file name suggestion for a transient file.
If a filename is marked transient, the higher level planners might
have some notion where to place it, or how to name it. Lower level
planners are not necessarily required to follow this hint.
the transient name suggestion of the file. The currentsettings will always be returned, regardless of the transiencystate of the file.
See Also: Filename.setTemporary(String) |
| getTransfer | | public int getTransfer()(Code) | | Accessor: Obtains the transfering mode.
true if the file will be tranferred to an output collector.
See Also: Filename.setTransfer(int)
since:
2.1 |
| getType | | public int getType()(Code) | | Accessor: Returns the predicate on the type of the LFN
the type of LFN
See Also: Filename.setType(int)
since:
2.1 |
| setDontRegister | | public void setDontRegister(boolean dontRegister)(Code) | | Accessor: Sets the predicate on registring with a replica catalog.
Parameters:
dontRegister - is false, if the file should be registered with areplica catalog.
See Also: Filename.setRegister()
since:
1.6 |
| setOptional | | public void setOptional(boolean optional)(Code) | | Acessor: Sets the optionality of the file.
Parameters:
optional - false, if the file is required, or true, if it isoptional.
See Also: Filename.getOptional()
since:
1.8 |
| setRegister | | public void setRegister(boolean register)(Code) | | Accessor: Sets the predicate on registring with a replica catalog.
Parameters:
register - is true, if the file should be registered with areplica catalog.
See Also: Filename.getRegister()
since:
2.1 |
| setTemporary | | public void setTemporary(String name)(Code) | | Accessor: Sets a file name suggestion for a transient file. If a
filename is marked transient, the higher level planners might have
some notion where to place it, or how to name it. Lower level
planners are not necessarily required to follow this hint.
Parameters:
name - is a transient name suggestion for this filename instance.No automatic marking of transiency will be done!
See Also: Filename.getTemporary() |
| setType | | public void setType(int type)(Code) | | Accessor: Sets the predicate on the type of the LFN
Parameters:
type - the type of LFN
See Also: Filename.getType()
since:
2.1 |
| setVariable | | public void setVariable(String variable)(Code) | | Accessor: Sets the responsible variable.
Parameters:
variable - the variable responsible for setting this LFN.
See Also: Filename.getVariable()
since:
1.7 |
| shortXML | | public String shortXML(String indent, String namespace, int flag)(Code) | | Dumps the state of the filename as PlainFilenameType or
StdioFilenameType without the transiency information.
Parameters:
indent - is a String of spaces used for prettyprinting. The initial amount of spaces should be an empty string.
Parameters:
namespace - is the XML schema namespace prefix. If neitherempty nor null, each element will be prefixed with this prefix,and the root element will map the XML namespace.
Parameters:
flag - 0x01: also dump the linkage information, 0x02: alsodump optionality a String which contains the state of the current classand its siblings using XML. Note that these strings might become large. |
| shortXML | | public void shortXML(Writer stream, String indent, String namespace, int flag) throws IOException(Code) | | Dumps the state of the filename as PlainFilenameType or
StdioFilenameType without the transiency information.
Parameters:
stream - is a stream opened and ready for writing. This can alsobe a string stream for efficient output.
Parameters:
indent - is a String of spaces used for prettyprinting. The initial amount of spaces should be an empty string.The parameter is used internally for the recursive traversal.
Parameters:
namespace - is the XML schema namespace prefix. If neitherempty nor null, each element will be prefixed with this prefix,and the root element will map the XML namespace.
Parameters:
flag - if 0x01, dump linkage, if 0x02 is set, dump optionality.
exception:
IOException - if something fishy happens to the stream. |
| toString | | public String toString()(Code) | | Convert the logical filename and linkage into something human
readable. The output is also slightly nudged towards machine
parsability. This method overwrites the inherited methods since it
appears to be faster to do it this way.
a textual description of the element and its attributes. |
| toString | | public void toString(Writer stream) throws IOException(Code) | | Converts the active state into something meant for human consumption.
The method will be called when recursively traversing the instance
tree.
Parameters:
stream - is a stream opened and ready for writing. This can alsobe a string stream for efficient output. |
| toXML | | public String toXML(String indent, String namespace)(Code) | | Dumps the state of the current element as XML output. This method
converts the data into pretty-printed XML output meant for machine
consumption. This method overwrites the inherited methods since it
appears to be faster to do it this way.
Parameters:
indent - is a String of spaces used for prettyprinting. The initial amount of spaces should be an empty string.
Parameters:
namespace - is the XML schema namespace prefix. If neitherempty nor null, each element will be prefixed with this prefix,and the root element will map the XML namespace. a String which contains the state of the current classand its siblings using XML. Note that these strings might become large. |
| toXML | | public void toXML(Writer stream, String indent, String namespace) throws IOException(Code) | | Dump the state of the current element as XML output. This function
traverses all sibling classes as necessary, and converts the data
into pretty-printed XML output. The stream interface should be able
to handle large output efficiently.
Parameters:
stream - is a stream opened and ready for writing. This can alsobe a string stream for efficient output.
Parameters:
indent - is a String of spaces used for prettyprinting. The initial amount of spaces should be an empty string.The parameter is used internally for the recursive traversal.
Parameters:
namespace - is the XML schema namespace prefix. If neitherempty nor null, each element will be prefixed with this prefix,and the root element will map the XML namespace.
exception:
IOException - if something fishy happens to the stream. |
|
|