A C E F G H L M N P R S U V

A

addVariable(String, String) - Method in class com.marklogic.shell.ShellQuery
 
asXQuery() - Method in class com.marklogic.shell.ShellQuery
 

C

Command - interface com.marklogic.shell.Command.
The interface for Commands
cat - class com.marklogic.shell.cat.
 
cat() - Constructor for class com.marklogic.shell.cat
 
checkConnection(String, String, String, int) - Method in class com.marklogic.shell.Shell
Tests the connection to Mark Logic.
com.marklogic.shell - package com.marklogic.shell
 
cp - class com.marklogic.shell.cp.
 
cp() - Constructor for class com.marklogic.shell.cp
 

E

Environment - interface com.marklogic.shell.Environment.
The interface that Enviroments must implement in order to support running commands.
echo - class com.marklogic.shell.echo.
 
echo() - Constructor for class com.marklogic.shell.echo
 
env - class com.marklogic.shell.env.
 
env() - Constructor for class com.marklogic.shell.env
 
execute(Environment, String) - Method in interface com.marklogic.shell.Command
 
execute(Environment, String) - Method in class com.marklogic.shell.cat
 
execute(Environment, String) - Method in class com.marklogic.shell.cp
 
execute(Environment, String) - Method in class com.marklogic.shell.echo
 
execute(Environment, String) - Method in class com.marklogic.shell.env
 
execute(Environment, String) - Method in class com.marklogic.shell.help
 
execute(Environment, String) - Method in class com.marklogic.shell.load
 
execute(Environment, String) - Method in class com.marklogic.shell.ls
 
execute(Environment, String) - Method in class com.marklogic.shell.rm
 
execute(Environment, String) - Method in class com.marklogic.shell.set
 
execute(Environment, String) - Method in class com.marklogic.shell.show
 
execute(Environment, String) - Method in class com.marklogic.shell.su
 
execute(Environment, String) - Method in class com.marklogic.shell.use
 
execute(Environment, String) - Method in class com.marklogic.shell.version
 
exit() - Method in interface com.marklogic.shell.Environment
Exit the envronment cleanly.
exit() - Method in class com.marklogic.shell.Shell
Exit the shell cleanly.
exitWithError(String) - Method in interface com.marklogic.shell.Environment
Exit the environment with an error.
exitWithError(String) - Method in class com.marklogic.shell.Shell
Exit the shell with an error message.

F

FileScanner - class com.marklogic.shell.FileScanner.
 
findFiles(String) - Static method in class com.marklogic.shell.FileScanner
 

G

getConsole() - Method in class com.marklogic.shell.Shell
The console reader used to read lines of input from the user.
getDataSource() - Method in interface com.marklogic.shell.Environment
Returns an XQDataSource.
getDataSource() - Method in class com.marklogic.shell.Shell
Returns an XQDataSource using the user, password, host, and port defined in the properties.
getHelp() - Method in interface com.marklogic.shell.Command
 
getHelp() - Method in class com.marklogic.shell.cat
 
getHelp() - Method in class com.marklogic.shell.cp
 
getHelp() - Method in class com.marklogic.shell.echo
 
getHelp() - Method in class com.marklogic.shell.env
 
getHelp() - Method in class com.marklogic.shell.help
 
getHelp() - Method in class com.marklogic.shell.load
 
getHelp() - Method in class com.marklogic.shell.ls
 
getHelp() - Method in class com.marklogic.shell.rm
 
getHelp() - Method in class com.marklogic.shell.set
 
getHelp() - Method in class com.marklogic.shell.show
 
getHelp() - Method in class com.marklogic.shell.su
 
getHelp() - Method in class com.marklogic.shell.use
 
getHelp() - Method in class com.marklogic.shell.version
 
getHistoryFile() - Method in class com.marklogic.shell.Shell
The history file used to store command line history.
getName() - Method in interface com.marklogic.shell.Command
 
getName() - Method in class com.marklogic.shell.cat
 
getName() - Method in class com.marklogic.shell.cp
 
getName() - Method in class com.marklogic.shell.echo
 
getName() - Method in class com.marklogic.shell.env
 
getName() - Method in class com.marklogic.shell.help
 
getName() - Method in class com.marklogic.shell.load
 
getName() - Method in class com.marklogic.shell.ls
 
getName() - Method in class com.marklogic.shell.rm
 
getName() - Method in class com.marklogic.shell.set
 
getName() - Method in class com.marklogic.shell.show
 
getName() - Method in class com.marklogic.shell.su
 
getName() - Method in class com.marklogic.shell.use
 
getName() - Method in class com.marklogic.shell.version
 
getOptions() - Method in class com.marklogic.shell.Shell
The command line options passed into the shell when it was first launched.
getProperties() - Method in interface com.marklogic.shell.Environment
The configuration properties for the environment.
getProperties() - Method in class com.marklogic.shell.Shell
The configuration properties for the shell environment.
getQuery() - Method in class com.marklogic.shell.ShellQuery
 
getUri(String, String) - Method in class com.marklogic.shell.load
 
getVars() - Method in class com.marklogic.shell.ShellQuery
 

H

help - class com.marklogic.shell.help.
 
help() - Constructor for class com.marklogic.shell.help
 

L

load - class com.marklogic.shell.load.
 
load() - Constructor for class com.marklogic.shell.load
 
loadDocument(Environment, String, File) - Method in class com.marklogic.shell.load
 
ls - class com.marklogic.shell.ls.
 
ls() - Constructor for class com.marklogic.shell.ls
 

M

main(String[]) - Static method in class com.marklogic.shell.Shell
 

N

NEWLINE - Static variable in interface com.marklogic.shell.Environment
Platform dependent newline char.

P

print(String) - Method in interface com.marklogic.shell.Environment
Prints a message.
print(String) - Method in class com.marklogic.shell.Shell
Print a message to the console.
printError(Exception) - Method in interface com.marklogic.shell.Environment
Prints an error that was caused by an exception.
printError(String) - Method in interface com.marklogic.shell.Environment
Prints an error message.
printError(String) - Method in class com.marklogic.shell.Shell
Prints an error to the console.
printError(Exception) - Method in class com.marklogic.shell.Shell
Print an error to the screen that was caused by an Exception.
printHelp() - Method in interface com.marklogic.shell.Environment
Prints the default help message.
printHelp(String) - Method in interface com.marklogic.shell.Environment
Prints a message along with the default help message.
printHelp() - Method in class com.marklogic.shell.Shell
Print the default help screen which will list all the command line options supported by the shell and a brief description of each.
printHelp(String) - Method in class com.marklogic.shell.Shell
Print a message along with the default help screen.
printLine(String) - Method in interface com.marklogic.shell.Environment
Prints a message with a line break.
printLine(String) - Method in class com.marklogic.shell.Shell
Print a message to the console with a newline.

R

rm - class com.marklogic.shell.rm.
 
rm() - Constructor for class com.marklogic.shell.rm
 
runXQuery(XQuery) - Method in interface com.marklogic.shell.Environment
Run an XQuery statement.
runXQuery(XQuery) - Method in class com.marklogic.shell.Shell
Runs an XQuery statement scrolling the result and displays the execution time in seconds for the query.
runXQuery(XQuery, boolean, boolean) - Method in class com.marklogic.shell.Shell
Runs an XQuery statement and optionally scrolls the result and optionally shows the execution time in seconds for the query.

S

Shell - class com.marklogic.shell.Shell.
Shell Environment for Mark Logic.
Shell() - Constructor for class com.marklogic.shell.Shell
Create a new Shell
ShellQuery - class com.marklogic.shell.ShellQuery.
 
ShellQuery(String, Shell) - Constructor for class com.marklogic.shell.ShellQuery
 
ShellQuery(Shell) - Constructor for class com.marklogic.shell.ShellQuery
 
set - class com.marklogic.shell.set.
 
set() - Constructor for class com.marklogic.shell.set
 
setQuery(String) - Method in class com.marklogic.shell.ShellQuery
 
show - class com.marklogic.shell.show.
 
show() - Constructor for class com.marklogic.shell.show
 
su - class com.marklogic.shell.su.
 
su() - Constructor for class com.marklogic.shell.su
 

U

use - class com.marklogic.shell.use.
 
use() - Constructor for class com.marklogic.shell.use
 

V

VERSION - Static variable in class com.marklogic.shell.Shell
Shell version
version - class com.marklogic.shell.version.
 
version() - Constructor for class com.marklogic.shell.version
 

A C E F G H L M N P R S U V

Copyright © 2005 Andrew Bruno