Package com.arangodb.internal

Class ArangoSearchImpl

java.lang.Object

com.arangodb.internal.ArangoExecuteable

com.arangodb.internal.InternalArangoView

com.arangodb.internal.InternalArangoSearch

com.arangodb.internal.ArangoSearchImpl

All Implemented Interfaces:

ArangoSearch, ArangoSerdeAccessor, ArangoView

public class ArangoSearchImpl
extends InternalArangoSearch
implements ArangoSearch

Author:

Mark Vollmary

Field Summary

Fields inherited from class com.arangodb.internal.InternalArangoView

dbName, name, PATH_API_ANALYZER, PATH_API_VIEW

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ArangoSearchImpl(ArangoDatabaseImpl db, String name)

Method Summary

Modifier and Type	Method	Description
ViewEntity	create()	Creates a view, then returns view information from the server.
ViewEntity	create(ArangoSearchCreateOptions options)	Creates a view with the given options, then returns view information from the server.
ArangoDatabase	db()	The the handler of the database the collection is within
void	drop()	Deletes the view from the database.
boolean	exists()	Checks whether the view exists.
ViewEntity	getInfo()	Returns information about the view.
ArangoSearchPropertiesEntity	getProperties()	Reads the properties of the specified view.
ViewEntity	rename(String newName)	Renames the view.
ArangoSearchPropertiesEntity	replaceProperties(ArangoSearchPropertiesOptions options)	Changes properties of the view.
ArangoSearchPropertiesEntity	updateProperties(ArangoSearchPropertiesOptions options)	Partially changes properties of the view.

Methods inherited from class com.arangodb.internal.InternalArangoSearch

getPropertiesRequest, replacePropertiesRequest, updatePropertiesRequest

Methods inherited from class com.arangodb.internal.InternalArangoView

dropRequest, getInfoRequest, name, renameRequest

Methods inherited from class com.arangodb.internal.ArangoExecuteable

createPath, executorAsync, executorSync, getSerde, request

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.arangodb.ArangoSerdeAccessor

getSerde

Methods inherited from interface com.arangodb.ArangoView

name

Constructor Details

ArangoSearchImpl

protected ArangoSearchImpl(ArangoDatabaseImpl db,
 String name)

Method Details

db

public ArangoDatabase db()

Description copied from interface: ArangoView

The the handler of the database the collection is within

Specified by:

db in interface ArangoView

Returns:

database handler

exists

public boolean exists()

Description copied from interface: ArangoView

Checks whether the view exists.

Specified by:

exists in interface ArangoView

Returns:

true if the view exists, otherwise false

See Also:

• API Documentation

drop

public void drop()

Description copied from interface: ArangoView

Deletes the view from the database.

Specified by:

drop in interface ArangoView

See Also:

• API Documentation

rename

public ViewEntity rename(String newName)

Description copied from interface: ArangoView

Renames the view.

Specified by:

rename in interface ArangoView

Parameters:

newName - The new name

Returns:

information about the view

See Also:

• API Documentation

getInfo

public ViewEntity getInfo()

Description copied from interface: ArangoView

Returns information about the view.

Specified by:

getInfo in interface ArangoView

Returns:

information about the view

See Also:

• API Documentation

create

public ViewEntity create()

Description copied from interface: ArangoSearch

Creates a view, then returns view information from the server.

Specified by:

create in interface ArangoSearch

Returns:

information about the view

See Also:

• API Documentation

create

public ViewEntity create(ArangoSearchCreateOptions options)

Description copied from interface: ArangoSearch

Creates a view with the given options, then returns view information from the server.

Specified by:

create in interface ArangoSearch

Parameters:

options - Additional options, can be null

Returns:

information about the view

See Also:

• API Documentation

getProperties

public ArangoSearchPropertiesEntity getProperties()

Description copied from interface: ArangoSearch

Reads the properties of the specified view.

Specified by:

getProperties in interface ArangoSearch

Returns:

properties of the view

See Also:

• API Documentation

updateProperties

public ArangoSearchPropertiesEntity updateProperties(ArangoSearchPropertiesOptions options)

Description copied from interface: ArangoSearch

Partially changes properties of the view.

Specified by:

updateProperties in interface ArangoSearch

Parameters:

options - properties to change

Returns:

properties of the view

See Also:

• API Documentation

replaceProperties

public ArangoSearchPropertiesEntity replaceProperties(ArangoSearchPropertiesOptions options)

Description copied from interface: ArangoSearch

Changes properties of the view.

Specified by:

replaceProperties in interface ArangoSearch

Parameters:

options - properties to change

Returns:

properties of the view

See Also:

• API Documentation