Package com.arangodb.internal

Class SearchAliasImpl

java.lang.Object

com.arangodb.internal.ArangoExecuteable

com.arangodb.internal.InternalArangoView

com.arangodb.internal.InternalSearchAlias

com.arangodb.internal.SearchAliasImpl

All Implemented Interfaces:

ArangoSerdeAccessor, ArangoView, SearchAlias

public class SearchAliasImpl
extends InternalSearchAlias
implements SearchAlias

Author:

Michele Rastelli

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	SearchAliasImpl(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(SearchAliasCreateOptions 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.
SearchAliasPropertiesEntity	getProperties()	Reads the properties of the specified view.
ViewEntity	rename(String newName)	Renames the view.
SearchAliasPropertiesEntity	replaceProperties(SearchAliasPropertiesOptions options)	Changes properties of the view.
SearchAliasPropertiesEntity	updateProperties(SearchAliasPropertiesOptions options)	Partially changes properties of the view.

Methods inherited from class com.arangodb.internal.InternalSearchAlias

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

SearchAliasImpl

protected SearchAliasImpl(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: SearchAlias

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

Specified by:

create in interface SearchAlias

Returns:

information about the view

See Also:

• API Documentation

create

public ViewEntity create(SearchAliasCreateOptions options)

Description copied from interface: SearchAlias

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

Specified by:

create in interface SearchAlias

Parameters:

options - Additional options, can be null

Returns:

information about the view

See Also:

• API Documentation

getProperties

public SearchAliasPropertiesEntity getProperties()

Description copied from interface: SearchAlias

Reads the properties of the specified view.

Specified by:

getProperties in interface SearchAlias

Returns:

properties of the view

See Also:

• API Documentation

updateProperties

public SearchAliasPropertiesEntity updateProperties(SearchAliasPropertiesOptions options)

Description copied from interface: SearchAlias

Partially changes properties of the view.

Specified by:

updateProperties in interface SearchAlias

Parameters:

options - properties to change

Returns:

properties of the view

See Also:

• API Documentation

replaceProperties

public SearchAliasPropertiesEntity replaceProperties(SearchAliasPropertiesOptions options)

Description copied from interface: SearchAlias

Changes properties of the view.

Specified by:

replaceProperties in interface SearchAlias

Parameters:

options - properties to change

Returns:

properties of the view

See Also:

• API Documentation