oracle.spatial.hadoop.vector.util

Class SpatialIndexMetadata

java.lang.Object

oracle.spatial.hadoop.vector.util.SpatialIndexMetadata

public class SpatialIndexMetadata
extends java.lang.Object

In-memory representation of a spatial index metadata

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpatialIndexMetadata.SpatialIndexEntry In-memory representation of a local spatial index metadata

Constructor Summary

Constructors

Constructor and Description
SpatialIndexMetadata() Creates a new instance

Method Summary

Methods

Modifier and Type	Method and Description
double[]	getBounds() Gets the dimensions minimum of maximum values
int	getDimensions() Gets the number of spatial dimensions of the indexed data
java.util.Set<java.lang.String>	getExtraFieldNames() Gets a set of all the extra field names contained in the spatial index
long	getIndexCount() Gets the number of local indexes
java.util.List<SpatialIndexMetadata.SpatialIndexEntry>	getIndexFiles() Gets a list of the metadata of each local index
java.lang.String	getIndexName() Gets the spatial index name
org.apache.hadoop.fs.Path	getIndexPath() Gets the path of the whole spatial index
double[]	getMbr() Gets the MBR of the whole indexed data
int	getSrid() Gets the SRID of the indexed data
double	getTolerance() Gets the tolerance that should be used with the indexed data
long	getTotalElemCount() Gets the number of indexed records
java.lang.String	getUserInputString()
boolean	isGeodetic() Tells whether the indexed data is geodetic or not
boolean	isMapFile()
void	setBounds(double[] bounds) Sets the dimensions minimum of maximum values
void	setDimensions(int dimensions) Sets the number of spatial dimensions of the indexed data
void	setExtraFieldNames(java.util.Set<java.lang.String> extraFieldNames) Sets a set of all the extra field names contained in the spatial index
void	setGeodetic(boolean geodetic) Sets whether the indexed data is geodetic or not
void	setIndexCount(long indexCount) Sets the number of local indexes
void	setIndexFiles(java.util.List<SpatialIndexMetadata.SpatialIndexEntry> indexFiles) Sets a list of the metadata of each local index
void	setIndexName(java.lang.String indexName) Sets the spatial index name
void	setIndexPath(org.apache.hadoop.fs.Path indexPath) Sets the path of the whole spatial index
void	setMapFile(boolean mapFile)
void	setMbr(double[] mbr) Sets the MBR of the whole indexed data
void	setSrid(int srid) Sets the SRID of the indexed data
void	setTolerance(double tolerance) Sets the tolerance that should be used with the indexed data
void	setTotalElemCount(long totalElemCount) Sets the number of indexed records
void	setUserInputString(java.lang.String inputString)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpatialIndexMetadata

public SpatialIndexMetadata()

Creates a new instance

Method Detail

getSrid

public int getSrid()

Gets the SRID of the indexed data

Returns:

an SRID

setSrid

public void setSrid(int srid)

Sets the SRID of the indexed data

Parameters:

srid - an SRID

isGeodetic

public boolean isGeodetic()

Tells whether the indexed data is geodetic or not

Returns:

true for geodetic

setGeodetic

public void setGeodetic(boolean geodetic)

Sets whether the indexed data is geodetic or not

Parameters:

geodetic - true for geodetic

getTolerance

public double getTolerance()

Gets the tolerance that should be used with the indexed data

Returns:

a tolerance value

setDimensions

public void setDimensions(int dimensions)

Sets the number of spatial dimensions of the indexed data

Parameters:

dimensions - the number of dimensions

getDimensions

public int getDimensions()

Gets the number of spatial dimensions of the indexed data

Returns:

the number of spatial dimensions

setBounds

public void setBounds(double[] bounds)

Sets the dimensions minimum of maximum values

Parameters:

bounds - dimensions bounds in the form dim1Min,dim2Min,dim1Max,dim2Max

getBounds

public double[] getBounds()

Gets the dimensions minimum of maximum values

Returns:

bounds dimensions bounds in the form dim1Min,dim2Min,dim1Max,dim2Max

setTolerance

public void setTolerance(double tolerance)

Sets the tolerance that should be used with the indexed data

Parameters:

tolerance - a tolerance value

getIndexPath

public org.apache.hadoop.fs.Path getIndexPath()

Gets the path of the whole spatial index

Returns:

a path

setIndexPath

public void setIndexPath(org.apache.hadoop.fs.Path indexPath)

Sets the path of the whole spatial index

Parameters:

indexPath - a path

getIndexName

public java.lang.String getIndexName()

Gets the spatial index name

Returns:

the spatial index name

setIndexName

public void setIndexName(java.lang.String indexName)

Sets the spatial index name

Parameters:

indexName - the spatial index name

getMbr

public double[] getMbr()

Gets the MBR of the whole indexed data

Returns:

an MBR in the form minX, minY, maxX, maxY

setMbr

public void setMbr(double[] mbr)

Sets the MBR of the whole indexed data

Parameters:

mbr - an MBR in the form minX, minY, maxX, maxY

getIndexCount

public long getIndexCount()

Gets the number of local indexes

Returns:

the number of local indexes

setIndexCount

public void setIndexCount(long indexCount)

Sets the number of local indexes

Parameters:

indexCount - the number of local indexes

getTotalElemCount

public long getTotalElemCount()

Gets the number of indexed records

Returns:

the number of indexed records

setTotalElemCount

public void setTotalElemCount(long totalElemCount)

Sets the number of indexed records

Parameters:

totalElemCount - the number of indexed records

getIndexFiles

public java.util.List<SpatialIndexMetadata.SpatialIndexEntry> getIndexFiles()

Gets a list of the metadata of each local index

Returns:

a list of the metadata of each local index

setIndexFiles

public void setIndexFiles(java.util.List<SpatialIndexMetadata.SpatialIndexEntry> indexFiles)

Sets a list of the metadata of each local index

Parameters:

indexFiles - a list of the metadata of each local index

getExtraFieldNames

public java.util.Set<java.lang.String> getExtraFieldNames()

Gets a set of all the extra field names contained in the spatial index

Returns:

a set of all the extra field names contained in the spatial index

setExtraFieldNames

public void setExtraFieldNames(java.util.Set<java.lang.String> extraFieldNames)

Sets a set of all the extra field names contained in the spatial index

Parameters:

extraFieldNames - a set of all the extra field names contained in the spatial index

isMapFile

public boolean isMapFile()

setMapFile

public void setMapFile(boolean mapFile)

setUserInputString

public void setUserInputString(java.lang.String inputString)

getUserInputString

public java.lang.String getUserInputString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object