Vertica 25.3.x – Java SDK Documentation

/*! Invisible class because of truncation */
class Invisible { };

/*! Truncated class, inheritance relation is hidden */
class Truncated : public Invisible { };

/* Class not documented with doxygen comments */
class Undocumented { };

/*! Class that is inherited using public inheritance */
class PublicBase : public Truncated { };

/*! A template class */
template class Templ { };

/*! Class that is inherited using protected inheritance */
class ProtectedBase { };

/*! Class that is inherited using private inheritance */
class PrivateBase { };

/*! Class that is used by the Inherited class */
class Used { };

/*! Super class that inherits a number of other classes */
class Inherited : public PublicBase,
protected ProtectedBase,
private PrivateBase,
public Undocumented,
public Templ
{
private:
Used *m_usedClass;
};

This will result in the following graph:

The boxes in the above graph have the following meaning:

A filled gray box represents the struct or class for which the graph is generated.
A box with a black border denotes a documented struct or class.
A box with a grey border denotes an undocumented struct or class.
A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.

The arrows have the following meaning:

A dark blue arrow is used to visualize a public inheritance relation between two classes.
A dark green arrow is used for protected inheritance.
A dark red arrow is used for private inheritance.
A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible.
A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labeled with the template parameters of the instance.

Api-Reference: Packages

Mon, 01 Jan 0001 00:00:00 +0000

Here are the packages with brief descriptions (if available):

[detail level 123]

com
vertica
sdk

Api-Reference: sdk Directory Reference

Mon, 01 Jan 0001 00:00:00 +0000

Directories
directory	vmap

Files
file	AnalyticFunction.java
file	AnalyticFunctionFactory.java
file	AnalyticPartitionReader.java
file	AnalyticPartitionWriter.java
file	BaseDataOID.java
file	Basics.java
file	BlockReader.java
file	BlockWriter.java
file	BuildInfo.java
file	ColumnTypes.java
file	ContinuousReader.java
file	ContinuousRejecter.java
file	ContinuousStreamer.java
file	ContinuousUDParser.java
file	ContinuousUDParserLocks.java
file	DataBuffer.java
file	DefaultSourceIterator.java
file	DestroyInvocation.java
file	DFSConstants.java
file	DFSFile.java
file	DFSFileReader.java
file	DFSFileStatus.java
file	DFSFileWriter.java
file	ExecutorParamWriter.java
file	ExecutorPlanContext.java
file	FileManager.java
file	FilterFactory.java
file	IdentComparator.java
file	IterativeSourceFactory.java
file	MultiPhaseTransformFunctionFactory.java
file	NodeSpecifyingPlanContext.java
file	NoopTypeCoercion.java
file	NullTypeCoercion.java
file	ParamReader.java
file	ParamWriter.java
file	ParserFactory.java
file	PartitionReader.java
file	PartitionWriter.java
file	PerColumnParamReader.java
file	PGUDxShared.java
file	PlanContext.java
file	Portion.java
file	RejectedRecord.java
file	ScalarFunction.java
file	ScalarFunctionFactory.java
file	ServerInterface.java
file	SessionParamReaderMap.java
file	SessionParamWriterMap.java
file	SizedColumnTypes.java
file	SourceFactory.java
file	SourceIterator.java
file	StandardTypeCoercion.java
file	State.java
file	StreamWriter.java
file	StringUtils.java
file	TimestampUDxShared.java
file	TransformFunction.java
file	TransformFunctionFactory.java
file	TransformFunctionPhase.java
file	TypeCoercion.java
file	TypeCoercionException.java
file	TypeCoercionPolicy.java
file	UdfException.java
file	UDFilter.java
file	UDLFactory.java
file	UDParser.java
file	UDSource.java
file	UDXFactory.java
file	UDXFunction.java
file	UDXLibrary.java
file	UDXObject.java
file	UnsizedUDSource.java
file	VerticaBlock.java
file	VerticaBuildInfo.java
file	VerticaType.java
file	VNumeric.java
file	VResources.java
file	VString.java

Api-Reference: v1 Directory Reference

Mon, 01 Jan 0001 00:00:00 +0000

Files
file	ByteMapTuple.java
file	Encoder.java
file	IdentMapTupleComparator.java
file	KeyComparator.java
file	KeySelector.java
file	ListIterator.java
file	MapTuple.java
file	NestedMapTuple.java
file	NullMapTuple.java

Api-Reference: vertica Directory Reference

Mon, 01 Jan 0001 00:00:00 +0000

Directories
directory	sdk

Api-Reference: vmap Directory Reference

Mon, 01 Jan 0001 00:00:00 +0000

Directories
directory	v1

Files
file	InvalidMapKeyException.java
file	VMapEncodingException.java