org.kepler.objectmanager.data.db

Class Entity

java.lang.Object

org.kepler.objectmanager.data.DataObjectDescription

org.kepler.objectmanager.data.db.Entity

All Implemented Interfaces:

DSTableFieldIFace, DSTableIFace

public class Entity
extends DataObjectDescription
implements DSTableIFace

This object represents an TableEntity. A TableEntity stores information about a table of Attributes that is used in a Step in the pipeline.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COLUMNMAJOR static variable for COLUMNMAJOR tables
static java.lang.String	GZIP
static java.lang.String	OTHERENTITY
static java.lang.String	ROWMAJOR static variable for ROWMAJOR tables
static java.lang.String	SPATIALRASTERENTITY
static java.lang.String	SPATIALVECTORENTITY
static java.lang.String	STOREDPROCEDUREENTITY
static java.lang.String	TABLEENTITY static variable for table type
static java.lang.String	TAR
static java.lang.String	VIEWENTITY
static java.lang.String	ZIP

Fields inherited from class org.kepler.objectmanager.data.DataObjectDescription

dataType, definition, id, missingValueCode, name

Constructor Summary

Constructors

Constructor and Description
Entity(java.lang.String id, java.lang.String name, java.lang.String description, AttributeList attributeList) Construct a TableEntity, setting the list of attributes.
Entity(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.Boolean caseSensitive, java.lang.String orientation, int numRecords) construct this object with some extra parameters

Method Summary

Modifier and Type	Method and Description
void	add(Attribute a) Add an Attribute to this table.
Attribute[]	getAttributes() Return the unit for this TableEntity
java.lang.Boolean	getCaseSensitive() indicates whether the tableEntity is caseSensitive or not
boolean	getCollapseDelimiter() Method to get if this entity can collapse consecutive delimiter
java.lang.String	getCompressionMethod() Method to get compression method for distribution file
DataCacheObject	getDataCacheObject() Method to get data cache item associated with this entity
TextComplexDataFormat[]	getDataFormatArray() Get the complex data format array
java.lang.String	getDBTableName()
java.lang.String	getDelimiter() get the delimiter used with this entity
java.util.Vector	getFields() Returns a Vector of the fields in the table
java.lang.String	getFileName() Returns the fileName.
boolean	getHasGZipDataFile() Method to get if the data file is gzip
boolean	getHasTarDataFile() Method to get if this has a tar data file
boolean	getHasZipDataFile() Method get if the data file is zip file
boolean	getIsImageEntity() If this entity for SpatialRaster or SpatialVector
java.lang.String	getMappedName() Return the name for this data item.
int	getNumFooterLines() get the number of footer lines in the entity
int	getNumHeaderLines() get the number of header lines in the entity
int	getNumRecords() gets the number of records in the table entity
java.lang.String	getOrientation() gets the orientation of the table entity
java.lang.String	getPhysicalLineDelimiter()
DSTableKeyIFace	getPrimaryKey() Returns a the Primary Key Definition for the table
java.lang.String	getRecordDelimiter() get the recordDelimiter used with this entity
java.lang.String	getURL()
boolean	isDownloadable() Return this entity is downloadable or not.
boolean	isMultiple() Returns multiple.
boolean	isSimpleDelimited() If data file in this entity is simple delimited
void	setAttributeList(AttributeList list) Method to set attribute list
void	setCollaplseDelimiter(boolean collapseDelimiter) Method to set collapse delimiter
void	setCompressionMethod(java.lang.String compressionMethod) Method to set compression method for distribution file
void	setDataCacheObject(DataCacheObject dataCacheObject) Method to set a cache data item associate with this entity
void	setDataFormatArray(TextComplexDataFormat[] dataFormatArray) Set DataFormatArray
void	setDBTableName(java.lang.String DBtableName)
void	setDelimiter(java.lang.String delim) set the delimiter used with this entity
void	setDownloadable(boolean isDownloadable) Set this entity downloadable or not. f the value of function attribute in url is "information", this entity wouldn't be downloaded
void	setFileName(java.lang.String fileName) Sets the fileName.
void	setHasGZipDataFile(boolean hasGZipDataFile) Method to set if the data file is gzip
void	setHasTarDataFile(boolean hasTarDataFile) Method to set if this has a tar data file
void	setHasZipDataFile(boolean isZipDataFile) Method to set if the data file is zip file
void	setIsImageEntity(boolean isImageEntity) Set if this is a Image entity
void	setMultiple() Sets the multiple to true.
void	setNumFooterLines(int numFooterLines) set the number of footer lines in the entity
void	setNumHeaderLines(int numHeaderLines) sets the number of header lines in the entity
void	setPhysicalLineDelimiter(java.lang.String physicalLineDelimiter)
void	setRecordDelimiter(java.lang.String delim) set the record delimiter used with this entity
void	setSimpleDelimited(boolean simpleDelimited)
void	setURL(java.lang.String url)
java.lang.String	toXml() Serialize the data item in XML format.

Methods inherited from class org.kepler.objectmanager.data.DataObjectDescription

addMissingValueCode, appendElement, equals, getDataType, getDefinition, getId, getMissingValueCode, getName, setDataType, setDefinition, setId, setMissingValueCode, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kepler.objectmanager.data.db.DSTableIFace

getName

Field Detail

ROWMAJOR

public static java.lang.String ROWMAJOR

static variable for ROWMAJOR tables

COLUMNMAJOR

public static java.lang.String COLUMNMAJOR

static variable for COLUMNMAJOR tables

ZIP

public static java.lang.String ZIP

TAR

public static java.lang.String TAR

GZIP

public static java.lang.String GZIP

TABLEENTITY

public static final java.lang.String TABLEENTITY

static variable for table type

See Also:

Constant Field Values

SPATIALRASTERENTITY

public static final java.lang.String SPATIALRASTERENTITY

See Also:

Constant Field Values

SPATIALVECTORENTITY

public static final java.lang.String SPATIALVECTORENTITY

See Also:

Constant Field Values

STOREDPROCEDUREENTITY

public static final java.lang.String STOREDPROCEDUREENTITY

See Also:

Constant Field Values

VIEWENTITY

public static final java.lang.String VIEWENTITY

See Also:

Constant Field Values

OTHERENTITY

public static final java.lang.String OTHERENTITY

See Also:

Constant Field Values

Constructor Detail

Entity

public Entity(java.lang.String id,
              java.lang.String name,
              java.lang.String description,
              java.lang.Boolean caseSensitive,
              java.lang.String orientation,
              int numRecords)

construct this object with some extra parameters

Parameters:

name - the name of the tableEntity

description - the description of the tableEntity

caseSensitive - indicates whether this tableEntity is caseSensitive or not.

orientation - indicates whether this tableEntity is column or row major

numRecords - the number of records in this tableEntity

Entity

public Entity(java.lang.String id,
              java.lang.String name,
              java.lang.String description,
              AttributeList attributeList)

Construct a TableEntity, setting the list of attributes.

Method Detail

add

public void add(Attribute a)

Add an Attribute to this table.

getAttributes

public Attribute[] getAttributes()

Return the unit for this TableEntity

getCaseSensitive

public java.lang.Boolean getCaseSensitive()

indicates whether the tableEntity is caseSensitive or not

getOrientation

public java.lang.String getOrientation()

gets the orientation of the table entity

getNumRecords

public int getNumRecords()

gets the number of records in the table entity

setNumHeaderLines

public void setNumHeaderLines(int numHeaderLines)

sets the number of header lines in the entity

setNumFooterLines

public void setNumFooterLines(int numFooterLines)

set the number of footer lines in the entity

Parameters:

numFooterLines -

getNumHeaderLines

public int getNumHeaderLines()

get the number of header lines in the entity

getNumFooterLines

public int getNumFooterLines()

get the number of footer lines in the entity

setDelimiter

public void setDelimiter(java.lang.String delim)

set the delimiter used with this entity

getDelimiter

public java.lang.String getDelimiter()

get the delimiter used with this entity

setRecordDelimiter

public void setRecordDelimiter(java.lang.String delim)

set the record delimiter used with this entity

getRecordDelimiter

public java.lang.String getRecordDelimiter()

get the recordDelimiter used with this entity

setURL

public void setURL(java.lang.String url)

getURL

public java.lang.String getURL()

setDBTableName

public void setDBTableName(java.lang.String DBtableName)

getDBTableName

public java.lang.String getDBTableName()

getCollapseDelimiter

public boolean getCollapseDelimiter()

Method to get if this entity can collapse consecutive delimiter

setCollaplseDelimiter

public void setCollaplseDelimiter(boolean collapseDelimiter)

Method to set collapse delimiter

Parameters:

collapseDelimiter -

getFileName

public java.lang.String getFileName()

Returns the fileName.

Returns:

String

setFileName

public void setFileName(java.lang.String fileName)

Sets the fileName.

Parameters:

fileName - The fileName to set

toXml

public java.lang.String toXml()

Serialize the data item in XML format.

setMultiple

public void setMultiple()

Sets the multiple to true.

isMultiple

public boolean isMultiple()

Returns multiple.

Returns:

boolean

getMappedName

public java.lang.String getMappedName()

Return the name for this data item.

Specified by:

getMappedName in interface DSTableIFace

Returns:

name as string

getFields

public java.util.Vector getFields()

Returns a Vector of the fields in the table

Specified by:

getFields in interface DSTableIFace

Returns:

vector

getPrimaryKey

public DSTableKeyIFace getPrimaryKey()

Returns a the Primary Key Definition for the table

Specified by:

getPrimaryKey in interface DSTableIFace

Returns:

object

getCompressionMethod

public java.lang.String getCompressionMethod()

Method to get compression method for distribution file

Returns:

String

setCompressionMethod

public void setCompressionMethod(java.lang.String compressionMethod)

Method to set compression method for distribution file

Parameters:

compressionMethod - String

getIsImageEntity

public boolean getIsImageEntity()

If this entity for SpatialRaster or SpatialVector

Returns:

boolean

setIsImageEntity

public void setIsImageEntity(boolean isImageEntity)

Set if this is a Image entity

Parameters:

isImageEntity - boolean

getHasZipDataFile

public boolean getHasZipDataFile()

Method get if the data file is zip file

Returns:

boolean

setHasZipDataFile

public void setHasZipDataFile(boolean isZipDataFile)

Method to set if the data file is zip file

Parameters:

isZipDataFile - boolean

getHasGZipDataFile

public boolean getHasGZipDataFile()

Method to get if the data file is gzip

Returns:

boolean

setHasGZipDataFile

public void setHasGZipDataFile(boolean hasGZipDataFile)

Method to set if the data file is gzip

Parameters:

hasGZipDataFile - boolean

getHasTarDataFile

public boolean getHasTarDataFile()

Method to get if this has a tar data file

Returns:

boolean

setHasTarDataFile

public void setHasTarDataFile(boolean hasTarDataFile)

Method to set if this has a tar data file

Parameters:

hasTarDataFile - boolean

getDataCacheObject

public DataCacheObject getDataCacheObject()

Method to get data cache item associated with this entity

Returns:

DataCacheObject

setDataCacheObject

public void setDataCacheObject(DataCacheObject dataCacheObject)

Method to set a cache data item associate with this entity

Parameters:

dataCacheObject - DataCachObject

isSimpleDelimited

public boolean isSimpleDelimited()

If data file in this entity is simple delimited

Returns:

Returns the simpleDelimited.

setSimpleDelimited

public void setSimpleDelimited(boolean simpleDelimited)

Parameters:

simpleDelimited - The simpleDelimited to set.

getDataFormatArray

public TextComplexDataFormat[] getDataFormatArray()

Get the complex data format array

Returns:

Returns the dataFormatArray.

setDataFormatArray

public void setDataFormatArray(TextComplexDataFormat[] dataFormatArray)

Set DataFormatArray

Parameters:

dataFormatArray - The dataFormatArray to set.

getPhysicalLineDelimiter

public java.lang.String getPhysicalLineDelimiter()

Returns:

Returns the physicalLineDelimiter.

setPhysicalLineDelimiter

public void setPhysicalLineDelimiter(java.lang.String physicalLineDelimiter)

Parameters:

physicalLineDelimiter - The physicalLineDelimiter to set.

setAttributeList

public void setAttributeList(AttributeList list)

Method to set attribute list

Parameters:

list -

isDownloadable

public boolean isDownloadable()

Return this entity is downloadable or not. If the value of function attribute in url is "information", this entity wouldn't be downloaded

setDownloadable

public void setDownloadable(boolean isDownloadable)

Set this entity downloadable or not. f the value of function attribute in url is "information", this entity wouldn't be downloaded

Parameters:

isDownloadable -