filetools.filesearchtools
Class MatlabHelpfileIndexer.FileInfo

java.lang.Object
  filetools.filesearchtools.MatlabHelpfileIndexer.FileInfo

Enclosing class:

MatlabHelpfileIndexer

protected class MatlabHelpfileIndexer.FileInfo
extends java.lang.Object

Helper class which keeps all collected information about a matlab-helpfile

Author:

osiris

Field Summary

java.lang.String	chapname
java.lang.String	chunkname
java.lang.String	docname
java.lang.String	filename fields for the information
private static int	FRAMEPAGE
private static int	INDEXPAGE
private static int	NAVPAGE
int	pagetype
java.lang.String	path
private static int	REGULAR filetype definitions
java.lang.String	specialData
java.lang.String	title
private static int	TOCPAGE

Constructor Summary

MatlabHelpfileIndexer.FileInfo(java.io.File file)
Constructor which takes the filename and path from the provided File-object

MatlabHelpfileIndexer.FileInfo(java.lang.String filename, java.lang.String path)
Constructor which needs to be told of the filename and path

Method Summary

MatlabHelpfileIndexer.FileInfo	escapeQuotes() Generates a new FileInfo object with the same information but escaped quoting characters
private java.lang.String	escapeQuoteString(java.lang.String input) Escapes any quoting characters in the given string
java.lang.String	getPageTypeString() Returns a String representation of the pagetype
boolean	isComplete()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

filename

public java.lang.String filename

fields for the information

path

public java.lang.String path

docname

public java.lang.String docname

chunkname

public java.lang.String chunkname

chapname

public java.lang.String chapname

title

public java.lang.String title

specialData

public java.lang.String specialData

pagetype

public int pagetype

REGULAR

private static final int REGULAR

filetype definitions

See Also:

Constant Field Values

FRAMEPAGE

private static final int FRAMEPAGE

See Also:

Constant Field Values

INDEXPAGE

private static final int INDEXPAGE

See Also:

Constant Field Values

NAVPAGE

private static final int NAVPAGE

See Also:

Constant Field Values

TOCPAGE

private static final int TOCPAGE

See Also:

Constant Field Values

Constructor Detail

MatlabHelpfileIndexer.FileInfo

public MatlabHelpfileIndexer.FileInfo(java.io.File file)

Constructor which takes the filename and path from the provided File-object

Parameters:

file - File this FileInfo object belongs to

MatlabHelpfileIndexer.FileInfo

public MatlabHelpfileIndexer.FileInfo(java.lang.String filename,
                                      java.lang.String path)

Constructor which needs to be told of the filename and path

Parameters:

filename - Name of the file this FileInfo object belongs to

path - Full path of the file this FileInfo object belongs to

Method Detail

isComplete

public boolean isComplete()

Returns:

True if all information which can be extracted for this type of file was found, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPageTypeString

public java.lang.String getPageTypeString()

Returns a String representation of the pagetype

Returns:

String representation of the pagetype

escapeQuotes

public MatlabHelpfileIndexer.FileInfo escapeQuotes()

Generates a new FileInfo object with the same information but escaped quoting characters

Returns:

New FileInfo object with escaped quotes

escapeQuoteString

private java.lang.String escapeQuoteString(java.lang.String input)

Escapes any quoting characters in the given string

Parameters:

input - String to escape

Returns:

Escaped string