com.metamatrix.modeler.core.metadata.runtime
Interface FileRecord

All Superinterfaces:

MetadataRecord, java.io.Serializable, VDBFile

All Known Implementing Classes:

FileRecordImpl

public interface FileRecord
extends MetadataRecord, VDBFile

This record represents any file in the vdb

Since:

4.2

Nested Class Summary

static interface	FileRecord.MetadataFieldNames Constants for names of accessor methods that map to fields stored on the FileRecords.
static interface	FileRecord.MetadataMethodNames Constants for names of accessor methods on the FileRecords.

Nested classes/interfaces inherited from interface com.metamatrix.modeler.core.metadata.runtime.MetadataRecord

MetadataRecord.MetadataRecordProperties

Method Summary

boolean	getBinary() Return true if this is a binary file else false.
FileRecord	getFileRecord() Get the instance of this class back
java.lang.String	getModelName() Return the name of the model this file represents
java.lang.String[]	getTokenReplacements() The strings used to replace tokens in the file in the vdb
java.lang.String[]	getTokens() The strings representing tokens in the file in the vdb
boolean	isIndexFile() Check if the record represents a index file record.
boolean	isModelFile() Check if the record represents a model file record.
void	setIndexSelector(IndexSelector selector) Set the indexSelector on this record.
void	setTokenReplacements(java.lang.String[] replacements) Set the strings used to replace a tokens in the file in the vdb
void	setTokens(java.lang.String[] tokens) Set the strings that tokens in the file that need to be replaced.

Methods inherited from interface com.metamatrix.modeler.core.metadata.runtime.MetadataRecord

getEObject, getFullName, getName, getNameInSource, getParentFullName, getParentPathString, getParentUUID, getPath, getPathString, getPropertyValue, getRecordType, getResourcePath, getUUID, setPropertyValue

Methods inherited from interface com.metamatrix.common.vdb.api.VDBFile

getContent, getFileLength, getPathInVdb

Method Detail

getBinary

boolean getBinary()

Return true if this is a binary file else false.

Returns:

true if this is a binary file else false.

Since:

4.2

getTokens

java.lang.String[] getTokens()

The strings representing tokens in the file in the vdb

Returns:

An array of strings that are tokens in the file that need to be replaced.

Since:

4.2

setTokens

void setTokens(java.lang.String[] tokens)

Set the strings that tokens in the file that need to be replaced.

Parameters:

tokens - The tokens in the file that need to be replaced

Since:

4.2

getTokenReplacements

java.lang.String[] getTokenReplacements()

The strings used to replace tokens in the file in the vdb

Returns:

The token replacement strings

Since:

4.2

setTokenReplacements

void setTokenReplacements(java.lang.String[] replacements)

Set the strings used to replace a tokens in the file in the vdb

Parameters:

replacements - The token replacement strings

Since:

4.2

getFileRecord

FileRecord getFileRecord()

Get the instance of this class back

Returns:

The instance of this calss

Since:

4.2

isModelFile

boolean isModelFile()

Check if the record represents a model file record.

Returns:

true if the record is a model or xsd file

Since:

4.2

isIndexFile

boolean isIndexFile()

Check if the record represents a index file record.

Returns:

true if the record is a index file

Since:

4.2

getModelName

java.lang.String getModelName()

Return the name of the model this file represents

Specified by:

getModelName in interface MetadataRecord

Returns:

The name of the model for the file

Since:

4.2

setIndexSelector

void setIndexSelector(IndexSelector selector)

Set the indexSelector on this record.

Parameters:

selector - The indexSelector used to look up file contents

Since:

4.2