Namespace: Consultingwerk.Util
Class 
PropathHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Util.PropathHelper

Inherits: Progress.Lang.Object

File:PropathHelper
Purpose:Supporting Methods for dealing with the PROPATH
Syntax:Static methods only, Protected constructor to disallow
instance creation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Dec 15 22:49:25 CET 2010

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ CHARACTER GetPropath (character, table) Returns the actual PROPATH entries based on the temp-table from a .propath file
+ CHARACTER GetPropathBaseFolder (character) Returns the propath entry/folder the given file name is located under
+ CHARACTER GetRelativeFileName (character) Returns the relative file name based on a matching PROPATH entry
+ LOGICAL IsAbsoluteDirectory (character) Tests if the current directory name is absolute of relative
+ CHARACTER MakeAbsolute (character, character) Turns a relative propath into an absolute path
+ ParseDotPropathFile (character, table) Parses a PDSOE project's .propath fil
+ CHARACTER PropathDelimiter () Returns the propath delimiter for the current OS

Top Constructor Summary
Options Name Purpose
PropathHelper () Static construtor for the PropathHelper class
# PropathHelper () Disallow instance creation


Method Detail
Top

PUBLIC CHARACTER GetPropath (character, table)
Purpose: Returns the actual PROPATH entries based on the temp-table
from a .propath file
Notes:

Parameters:
pcBasePath CHARACTER
The base path (current directory)
ttPropath TEMP-TABLE ttPropath
The OUTPUT temp-table with the propath entries
Returns CHARACTER
The PROPATH resulting from the temp-table
Top

PUBLIC CHARACTER GetPropathBaseFolder (character)
Purpose: Returns the propath entry/folder the given file name is located under
Notes: Supports relative and absolute file names for existing files and
absolute file names for non existing files. File Names / folders will
be returned with forward slash

Parameters:
pcFileName CHARACTER
The file name to locate in a PROPATH folder
Returns CHARACTER
The absolute path representation of the PROPATH entry containing the given file path
Top

PUBLIC CHARACTER GetRelativeFileName (character)
Purpose: Returns the relative file name based on a matching PROPATH entry
Notes:

Parameters:
pcFileName CHARACTER
The file name to locate in a PROPATH folder
Returns CHARACTER
The relative file name
Top

PUBLIC LOGICAL IsAbsoluteDirectory (character)
Purpose: Tests if the current directory name is absolute of relative
Notes: Absolute paths start with either a / (slash) or a double \\ (UNC)
or a letter followed by a colon

Parameters:
pcDirectory CHARACTER
The name of the directory to test
Returns LOGICAL
Logical value indicating if the directory is specified as an absolute path
Top

PUBLIC CHARACTER MakeAbsolute (character, character)
Purpose: Turns a relative propath into an absolute path
Notes:

Parameters:
pcBasePath CHARACTER
The relative path to be used as a base for relative references
pcPropath CHARACTER
The propath to make absolute
Returns CHARACTER
The propath with only absolute path references
Top

PUBLIC ParseDotPropathFile (character, table)
Purpose: Parses a PDSOE project's .propath fil
Notes:

Parameters:
pcFileName CHARACTER
The name of the .propath file to parse
ttPropath TEMP-TABLE ttPropath
The OUTPUT temp-table with the propath entries
Top

PUBLIC CHARACTER PropathDelimiter ()
Purpose: Returns the propath delimiter for the current OS
Notes: Accoording to the OpenEdge documentation, even UNIX sessions
use the comma as the propath delimiter from within the AVM so this
method is just left for backwards compatibility

Returns CHARACTER
The comma as the propath


Constructor Detail
Top

STATIC PropathHelper ()
Purpose: Static construtor for the PropathHelper class
Notes:

Top

PROTECTED PropathHelper ()
Purpose: Disallow instance creation
Notes:



Temp-Table Detail

Temp-Table ttPropath

Defined in:


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:16:58