edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile Class Reference

A reference to a source file in an HPCView experiment. More...

Inheritance diagram for edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile:
Inheritance graph
[legend]
Collaboration diagram for edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 FileSystemSourceFile (BaseExperiment experiment, File filename, int idFile)
int getFileID ()
String getName ()
File getFilename ()
int getLineCount ()
InputStream getStream ()
boolean isAvailable ()
boolean isText ()
void setIsText (boolean bi)
boolean hasLine (int lineNumber)
String getCompleteFilename ()
 Laks: need this function for Eclipse editor ! Get the complete filename when it is available based on resolvedPath.

Static Public Attributes

static final int STATICID = 1111
 The type ID of the Source file.
static final SourceFile NONE = new EmptySourceFile()
 Empty source file for use by scopes which logically lack a source file.

Protected Member Functions

void computeLineCount ()
void requireAvailable ()
void searchForContents ()
File makeSearchFile (File search)

Protected Attributes

BaseExperiment experiment
 The experiment owning this source file.
File filename
 The filename of this source file.
boolean hasBeenSought
 Whether an attempt has been made to locate this source file's contents.
boolean contentsAvailable
 Whether this source file's contents can be located and read.
File resolvedPath
 The actual path to this source file's contents, lazily computed.
int lineCount
 The number of lines in this source file, lazily computed.
boolean istext
String longName
int id
 The ID of the file, to be looked in the experiment's hashtable.

Detailed Description

A reference to a source file in an HPCView experiment.

Definition at line 40 of file FileSystemSourceFile.java.

Constructor & Destructor Documentation

edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.FileSystemSourceFile ( BaseExperiment  experiment,
File  filename,
int  idFile 
)

Definition at line 84 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.contentsAvailable, edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.hasBeenSought, edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.istext, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.longName.

Member Function Documentation

void edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.computeLineCount (  )  [protected]

Definition at line 176 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.contentsAvailable, edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getStream(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.lineCount.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getLineCount().

String edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getCompleteFilename (  ) 

Laks: need this function for Eclipse editor ! Get the complete filename when it is available based on resolvedPath.

Returns:
the complete absolute file path

Definition at line 375 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.contentsAvailable, edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getFilename(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.resolvedPath.

Referenced by edu.rice.cs.hpc.viewer.editor.EditorManager.displayFileEditor().

int edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getFileID (  )  [virtual]

Implements edu.rice.cs.hpc.data.experiment.source.SourceFile.

Definition at line 113 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.id.

File edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getFilename (  )  [virtual]

Implements edu.rice.cs.hpc.data.experiment.source.SourceFile.

Definition at line 141 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.filename.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getCompleteFilename().

int edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getLineCount (  )  [virtual]

Implements edu.rice.cs.hpc.data.experiment.source.SourceFile.

Definition at line 157 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.computeLineCount(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.lineCount, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.requireAvailable().

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.hasLine().

String edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getName (  )  [virtual]

Implements edu.rice.cs.hpc.data.experiment.source.SourceFile.

Definition at line 121 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.filename, edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.istext, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.longName.

Referenced by edu.rice.cs.hpc.viewer.editor.EditorManager.displayFileEditor(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.requireAvailable().

InputStream edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getStream (  )  [virtual]

Implements edu.rice.cs.hpc.data.experiment.source.SourceFile.

Definition at line 211 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.requireAvailable(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.resolvedPath.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.computeLineCount().

boolean edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.hasLine ( int  lineNumber  )  [virtual]

Implements edu.rice.cs.hpc.data.experiment.source.SourceFile.

Definition at line 268 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.contentsAvailable, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getLineCount().

boolean edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.isAvailable (  )  [virtual]

Implements edu.rice.cs.hpc.data.experiment.source.SourceFile.

Definition at line 243 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.contentsAvailable, edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.hasBeenSought, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.searchForContents().

Referenced by edu.rice.cs.hpc.viewer.util.Utilities.isFileReadable(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.requireAvailable().

boolean edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.isText (  )  [virtual]

Implements edu.rice.cs.hpc.data.experiment.source.SourceFile.

Definition at line 253 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.istext.

File edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.makeSearchFile ( File  search  )  [protected]

Definition at line 352 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.experiment, edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.filename, and edu.rice.cs.hpc.data.experiment.BaseExperiment.getDefaultDirectory().

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.searchForContents().

void edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.requireAvailable (  )  [protected]

Definition at line 285 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getName(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.isAvailable().

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getLineCount(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getStream().

void edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.searchForContents (  )  [protected]

Definition at line 309 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.contentsAvailable, edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.experiment, edu.rice.cs.hpc.data.experiment.BaseExperimentWithMetrics.getSearchPath(), edu.rice.cs.hpc.data.experiment.BaseExperimentWithMetrics.getSearchPathCount(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.hasBeenSought, edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.lineCount, edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.makeSearchFile(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.resolvedPath.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.isAvailable().

void edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.setIsText ( boolean  bi  )  [virtual]

Implements edu.rice.cs.hpc.data.experiment.source.SourceFile.

Definition at line 259 of file FileSystemSourceFile.java.

References edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.istext.

Member Data Documentation

boolean edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.contentsAvailable [protected]

Whether this source file's contents can be located and read.

Definition at line 54 of file FileSystemSourceFile.java.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.computeLineCount(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.FileSystemSourceFile(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getCompleteFilename(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.hasLine(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.isAvailable(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.searchForContents().

BaseExperiment edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.experiment [protected]

The experiment owning this source file.

Definition at line 45 of file FileSystemSourceFile.java.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.makeSearchFile(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.searchForContents().

File edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.filename [protected]

The filename of this source file.

Definition at line 48 of file FileSystemSourceFile.java.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getFilename(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getName(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.makeSearchFile().

boolean edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.hasBeenSought [protected]

Whether an attempt has been made to locate this source file's contents.

Definition at line 51 of file FileSystemSourceFile.java.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.FileSystemSourceFile(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.isAvailable(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.searchForContents().

int edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.id [protected]

The ID of the file, to be looked in the experiment's hashtable.

Definition at line 71 of file FileSystemSourceFile.java.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getFileID().

boolean edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.istext [protected]

Definition at line 64 of file FileSystemSourceFile.java.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.FileSystemSourceFile(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getName(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.isText(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.setIsText().

int edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.lineCount [protected]

The number of lines in this source file, lazily computed.

Should not be accessed unless this.contentsAvailable.

Definition at line 62 of file FileSystemSourceFile.java.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.computeLineCount(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getLineCount(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.searchForContents().

String edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.longName [protected]

Definition at line 66 of file FileSystemSourceFile.java.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.FileSystemSourceFile(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getName().

final SourceFile edu.rice.cs.hpc.data.experiment.source.SourceFile.NONE = new EmptySourceFile() [static, inherited]

Empty source file for use by scopes which logically lack a source file.

Definition at line 45 of file SourceFile.java.

Referenced by edu.rice.cs.hpc.viewer.util.Utilities.isFileReadable().

File edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.resolvedPath [protected]

The actual path to this source file's contents, lazily computed.

Should not be accessed unless this.contentsAvailable.

Definition at line 58 of file FileSystemSourceFile.java.

Referenced by edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getCompleteFilename(), edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.getStream(), and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.searchForContents().

final int edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.STATICID = 1111 [static]

The type ID of the Source file.

Definition at line 43 of file FileSystemSourceFile.java.

The documentation for this class was generated from the following file:
Generated on 5 May 2015 for HPCVIEWER by  doxygen 1.6.1