com.ibm.etools.iseries.perspective.model.util
Class ISeriesNativeObjectBasicUtil

java.lang.Object
  com.ibm.etools.iseries.perspective.model.util.ISeriesNativeObjectBasicUtil

public class ISeriesNativeObjectBasicUtil
extends Object

This is a utility class for dealing with AbstractISeriesNativeObject objects that represent iSeries objects in the iSeries Project Object Model.
Refer to ISeriesModelConstants for the full list of properties.

Field Summary

static String

Copyright

Constructor Summary

ISeriesNativeObjectBasicUtil()

Method Summary

static Properties	getDefaultSourceFileProperties() Returns a Properties object containing the default values for all predefined properties of an iSeries Source Physical File.
static Properties	getPreferredSourceFileProperties() Returns a Properties object containing the default values for all predefined properties of an iSeries Source Physical File.
static Properties	getSourceFileProperties(int ccsid, int recordLength, boolean isDBCS, String description) Returns a Properties object populated with all the predefined properties of an iSeries Source Physical File.
static Properties	getSourceFileProperties(IQSYSFile sourceFile) Returns a Properties object containing all the predefined properties of an iSeries Source Physical File.
static Properties	getSourceFileProperties(String ccsid, int recordLength, boolean isDBCS, String description) Returns a Properties object populated with all the predefined properties of an iSeries Source Physical File.
static Properties	getSourceFileProperties(String ccsid, String recordLength, String isDBCS, String description) Returns a Properties object populated with all the predefined properties of an iSeries Source Physical File.

Methods inherited from class java.lang.Object

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

Field Detail

Copyright

public static final String Copyright

See Also:

Constant Field Values

Constructor Detail

ISeriesNativeObjectBasicUtil

public ISeriesNativeObjectBasicUtil()

Method Detail

getDefaultSourceFileProperties

public static final Properties getDefaultSourceFileProperties()

Returns a Properties object containing the default values for all predefined properties of an iSeries Source Physical File. The default values of the properties are the same as the ones used for a crtsrcpf command on an iSeries machine. ie: CCSID is *JOB, Record length is 92, DBCS is false and Text description is empty. This method is useful when constructing a properties object thats needs default values. Typically use: Properties mySrcpfProperties = new Properties(getDefaultSourceFileProperties()); Creates an empty property list with the iSeries defaults.

Returns:

Properties a Properties object containing default values for all the iSeries source physical file properties.

getPreferredSourceFileProperties

public static final Properties getPreferredSourceFileProperties()

Returns a Properties object containing the default values for all predefined properties of an iSeries Source Physical File. The default values of the properties are not quite the same as the ones used for a crtsrcpf command on an iSeries machine. ie: CCSID is *JOB, Record length is 92, DBCS is false and Text description is empty. This method is useful when constructing a properties object thats needs default values. Typically use: Properties mySrcpfProperties = new Properties(getPreferredSourceFileProperties()); Creates an empty property list with the preferred iSeries properties as default values.

Returns:

Properties a Properties object containing default values for all the iSeries source physical file properties.

getSourceFileProperties

public static final Properties getSourceFileProperties(IQSYSFile sourceFile)
                                                throws SystemMessageException

Returns a Properties object containing all the predefined properties of an iSeries Source Physical File. These properties are extracted from the argument.

Parameters:

srcpf - the source physical file from which to get the properties.

Returns:

the Properties object containing all the iSeries source physical file properties. All keys and values are stored as Strings.

Throws:

SystemMessageException - if there was a problem retrieving any properties

getSourceFileProperties

public static final Properties getSourceFileProperties(int ccsid,
                                                       int recordLength,
                                                       boolean isDBCS,
                                                       String description)

Returns a Properties object populated with all the predefined properties of an iSeries Source Physical File. The method creates the Properties object and populates it with the correct key/value pairs according to the passed property values.

Parameters:

ccsid - CCSID for newly created source physical file.

recordLength - record length for newly created source physical file.

isDBCS - IGCData for newly created source physical file.

description - description for newly created source physical file.

Returns:

Properties The Properties list containing all the iSeries source physical file properties. All keys and values are stored as Strings.

getSourceFileProperties

public static final Properties getSourceFileProperties(String ccsid,
                                                       int recordLength,
                                                       boolean isDBCS,
                                                       String description)

Returns a Properties object populated with all the predefined properties of an iSeries Source Physical File. The method creates the Properties object and populates it with the correct key/value pairs according to the passed property values. Note: convenience method if CCSID is *JOB or *HEX.

Parameters:

ccsid - CCSID for newly created source physical file.

recordLength - record length for newly created source physical file.

isDBCS - IGCData for newly created source physical file.

description - description for newly created source physical file.

Returns:

Properties The Properties list containg all the iSeries source physical file properties.

getSourceFileProperties

public static final Properties getSourceFileProperties(String ccsid,
                                                       String recordLength,
                                                       String isDBCS,
                                                       String description)

Returns a Properties object populated with all the predefined properties of an iSeries Source Physical File. The method creates the Properties object and populates it with the correct key/value pairs according to the passed property values.

Parameters:

ccsid - CCSID for newly created source physical file.

recordLength - record length for newly created source physical file.

isDBCS - true if the source file contains DBCS characters.

description - description for newly created source physical file.

Returns:

Properties The Properties list containg all the iSeries source physical file properties.