Java Doc for PegasusFile.java in  » Workflow-Engines » pegasus-2.1.0 » org » griphyn » cPlanner » classes » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Workflow Engines » pegasus 2.1.0 » org.griphyn.cPlanner.classes   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.griphyn.cPlanner.classes.Data       org.griphyn.cPlanner.classes.PegasusFile All known Subclasses:   org.griphyn.cPlanner.classes.FileTransfer, PegasusFile public class PegasusFile extends Data (Code) The logical file object that contains the logical filename which is got from the DAX, and the associated set of flags specifying the transient characteristics. It ends up associating the following information with a lfn -type of the file (data or executable) -optionality of a file -transient attributes of a file (dontTransfer and dontRegister) author:    Gaurang Mehta author:    Karan Vahi version:    $Revision: 373 $ Field Summary final public static  int DATA_FILE      The type denoting that a logical file is a data file. final public static  String DATA_TYPE      The string value of a file that is of type data. final public static  int EXECUTABLE_FILE      The type denoting that a logical file is a executable file. final public static  String EXECUTABLE_TYPE      The string value of a file that is of type executable. final public static  int NO_OF_TRANSIENT_FLAGS      The number of transient flags. final public static  int TRANSFER_MANDATORY      The mode where the transfer for this file to the pool is constructed and the transfer job fails if the transfer fails. final public static  int TRANSFER_NOT      The mode where the transfer for this file is not constructed. final public static  int TRANSFER_OPTIONAL      The mode where the transfer for this file to the pool is constructed, but the transfer job should not fail if the transfer fails. final public static  int TRANSIENT_OPTIONAL_FLAG      The index of the flags field which when set indicates that the file is to be considered optional. final public static  int TRANSIENT_REGISTRATION_FLAG      The index of the flags field which when set indicates that the file is not to be registered in the RLS/ RC. protected  BitSet mFlags      The transient flags field which is kept as a bit field. protected  String mLogicalFile      The logical name of the file. protected  int mTransferFlag      The transfer flag associated with the file containing tristate of transfer,dontTransfer and optional. protected  int mType      The type associated with the file. Constructor Summary public   PegasusFile()      The default constructor. public   PegasusFile(String logName)      The overloaded constructor. Method Summary public  Object clone()      Returns a copy of the existing data object. public  boolean equals(Object o)      Checks if an object is similar to the one referred to by this class. public  boolean fileOptional()      Returns optionalflag denoting the file to be optional or not. public  BitSet getFlags()      Returns the bit fields that contain the transient flags (dR and optional). public  String getLFN()      It returns the lfn of the file that is associated with this transfer. public  int getTransferFlag()      Returns the tristate transfer mode that is associated with the file. public  boolean getTransientRegFlag()      Returns the transient registration flag (the value of dontRegister). public  boolean getTransientTransferFlag()      Returns whether the transfer is transient or not. public  int getType()      Returns the tristate transfer mode that is associated with the file. public  int hashCode()      Calculate a hash code value for the object to support hash tables. public  void setFileOptional()      Sets the optionalflag denoting the file to be optional to true. public  void setLFN(String lfn)      It sets the logical filename of the file that is being transferred. public  void setTransferFlag(int transfer)      Sets the transient transfer flag to value passed. public  void setTransferFlag(String flag, boolean doubleNegative)      Sets the transient transfer flag corresponding to the string value of transfer mode passed. public  void setTransientRegFlag()      Sets the transient registration flag to true. public  void setType(int type)      Sets the type flag to value passed. public  void setType(String type)      Sets the transient transfer flag to value passed. public  String toString()      Returns the String version of the data object, which is in human readable form. public  boolean transferInRange(int transfer)      Returns whether the transfer value for the mode is in range or not. Parameters:   transfer - the value for the transfer. public  String typeToString()      Returns the type associated with the logical file. public  boolean typeValid(int type)      Returns whether the type of file value is valid or not. Parameters:   type - the value for the type of file. Field Detail DATA_FILE final public static int DATA_FILE(Code) The type denoting that a logical file is a data file. DATA_TYPE final public static String DATA_TYPE(Code) The string value of a file that is of type data. See Also:   PegasusFile.DATA_FILE EXECUTABLE_FILE final public static int EXECUTABLE_FILE(Code) The type denoting that a logical file is a executable file. EXECUTABLE_TYPE final public static String EXECUTABLE_TYPE(Code) The string value of a file that is of type executable. See Also:   PegasusFile.DATA_FILE NO_OF_TRANSIENT_FLAGS final public static int NO_OF_TRANSIENT_FLAGS(Code) The number of transient flags. This is the length of the BitSet in the flags fields. TRANSFER_MANDATORY final public static int TRANSFER_MANDATORY(Code) The mode where the transfer for this file to the pool is constructed and the transfer job fails if the transfer fails. The corresponding dT (dontTransfer) value is false. TRANSFER_NOT final public static int TRANSFER_NOT(Code) The mode where the transfer for this file is not constructed. The corresponding dT (dontTransfer) value is true. TRANSFER_OPTIONAL final public static int TRANSFER_OPTIONAL(Code) The mode where the transfer for this file to the pool is constructed, but the transfer job should not fail if the transfer fails. The corresponding dT (dontTransfer) value is optional. TRANSIENT_OPTIONAL_FLAG final public static int TRANSIENT_OPTIONAL_FLAG(Code) The index of the flags field which when set indicates that the file is to be considered optional. TRANSIENT_REGISTRATION_FLAG final public static int TRANSIENT_REGISTRATION_FLAG(Code) The index of the flags field which when set indicates that the file is not to be registered in the RLS/ RC. mFlags protected BitSet mFlags(Code) The transient flags field which is kept as a bit field. It keeps track of the dontRegister and optional attributes associated with the filename in the dax. mLogicalFile protected String mLogicalFile(Code) The logical name of the file. mTransferFlag protected int mTransferFlag(Code) The transfer flag associated with the file containing tristate of transfer,dontTransfer and optional. See Also:   PegasusFile.TRANSFER_MANDATORY See Also:   PegasusFile.TRANSFER_OPTIONAL See Also:   PegasusFile.TRANSFER_NOT mType protected int mType(Code) The type associated with the file. It can either be a data file or an executable file. See Also:   PegasusFile.DATA_FILE See Also:   PegasusFile.EXECUTABLE_FILE Constructor Detail PegasusFile public PegasusFile()(Code) The default constructor. PegasusFile public PegasusFile(String logName)(Code) The overloaded constructor. Parameters:   logName - the logical name of the file. Method Detail clone public Object clone()(Code) Returns a copy of the existing data object. clone of the object. equals public boolean equals(Object o)(Code) Checks if an object is similar to the one referred to by this class. We compare the primary key to determine if it is the same or not. true if the primary key (lfn) matches.else false. fileOptional public boolean fileOptional()(Code) Returns optionalflag denoting the file to be optional or not. true denoting the file is optional.false denoting that file is not optional. getFlags public BitSet getFlags()(Code) Returns the bit fields that contain the transient flags (dR and optional). See Also:   PegasusFile.NO_OF_TRANSIENT_FLAGS See Also:   PegasusFile.TRANSIENT_OPTIONAL_FLAG See Also:   PegasusFile.TRANSIENT_REGISTRATION_FLAG getLFN public String getLFN()(Code) It returns the lfn of the file that is associated with this transfer. the lfn associated with the transfer getTransferFlag public int getTransferFlag()(Code) Returns the tristate transfer mode that is associated with the file. the int value denoting the tristate. See Also:   PegasusFile.TRANSFER_MANDATORY See Also:   PegasusFile.TRANSFER_NOT See Also:   PegasusFile.TRANSFER_OPTIONAL getTransientRegFlag public boolean getTransientRegFlag()(Code) Returns the transient registration flag (the value of dontRegister). true denoting the file need not be registered into the replicacatalog.false denoting that file needs to be registered. getTransientTransferFlag public boolean getTransientTransferFlag()(Code) Returns whether the transfer is transient or not. By transient we mean no transfer. true if transfer mode is TRANSFER_NOTfalse if transfer mandatory or optional. getType public int getType()(Code) Returns the tristate transfer mode that is associated with the file. the int value denoting the type. See Also:   PegasusFile.DATA_FILE See Also:   PegasusFile.EXECUTABLE_FILE hashCode public int hashCode()(Code) Calculate a hash code value for the object to support hash tables. a hash code value for the object. setFileOptional public void setFileOptional()(Code) Sets the optionalflag denoting the file to be optional to true. setLFN public void setLFN(String lfn)(Code) It sets the logical filename of the file that is being transferred. Parameters:   lfn - the logical name of the file that this transfer is associatedwith. setTransferFlag public void setTransferFlag(int transfer) throws IllegalArgumentException(Code) Sets the transient transfer flag to value passed. Parameters:   transfer - valid transfer value. exception:   IllegalArgumentException - if the transfer mode is outsideits legal range. See Also:   PegasusFile.TRANSFER_MANDATORY See Also:   PegasusFile.TRANSFER_NOT See Also:   PegasusFile.TRANSFER_OPTIONAL setTransferFlag public void setTransferFlag(String flag, boolean doubleNegative) throws IllegalArgumentException(Code) Sets the transient transfer flag corresponding to the string value of transfer mode passed. The legal range of transfer values is true|false|optional. Parameters:   flag - tri-state transfer value as got from dontTransfer flag. Parameters:   doubleNegative - indicates whether a double negative or not. exception:   IllegalArgumentException - if the transfer mode is outsideits legal range. See Also:   PegasusFile.TRANSFER_MANDATORY See Also:   PegasusFile.TRANSFER_NOT See Also:   PegasusFile.TRANSFER_OPTIONAL setTransientRegFlag public void setTransientRegFlag()(Code) Sets the transient registration flag to true. setType public void setType(int type) throws IllegalArgumentException(Code) Sets the type flag to value passed. Parameters:   type - valid transfer value. exception:   IllegalArgumentException - if the transfer mode is outsideits legal range. See Also:   PegasusFile.DATA_FILE See Also:   PegasusFile.EXECUTABLE_FILE setType public void setType(String type) throws IllegalArgumentException(Code) Sets the transient transfer flag to value passed. Parameters:   type - valid transfer value. exception:   IllegalArgumentException - if the transfer mode is outsideits legal range. See Also:   PegasusFile.DATA_FILE See Also:   PegasusFile.EXECUTABLE_FILE toString public String toString()(Code) Returns the String version of the data object, which is in human readable form. the dump of the data object into a string. transferInRange public boolean transferInRange(int transfer)(Code) Returns whether the transfer value for the mode is in range or not. Parameters:   transfer - the value for the transfer. true if the value is in range.false if the value is not in range. typeToString public String typeToString()(Code) Returns the type associated with the logical file. type of the file. typeValid public boolean typeValid(int type)(Code) Returns whether the type of file value is valid or not. Parameters:   type - the value for the type of file. true if the value is in range.false if the value is not in range. Fields inherited from org.griphyn.cPlanner.classes.Data public String mLogMsg(Code)(Java Doc) public LogManager mLogger(Code)(Java Doc) Methods inherited from org.griphyn.cPlanner.classes.Data public String setToString(Set s, String delim)(Code)(Java Doc) abstract public String toString()(Code)(Java Doc) public String vectorToString(String heading, Vector vector)(Code)(Java Doc) Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)