|
Xindice API version 1.1 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xindice.tools.XMLTools
XMLAdmin is designed to take command line arguments and give user Xindice management flexibility within the current Database.
Field Summary | |
static String |
ACTION
|
static String |
AUTO_KEY
|
static String |
COLLECTION
|
static String |
COMMAND_LIST
|
static String |
DB_CONFIG
|
static String |
DB_SERVER
|
static String |
EXTENSION
|
static String |
FILE_PATH
|
static String |
FILER
|
static String |
HOST
|
static String |
IMPL_CLASS
|
static String |
LOCAL
|
static String |
MAX_KEY_SIZE
|
static String |
NAME_OF
|
static String |
NAMESPACES
|
static String |
PAGE_COUNT
|
static String |
PAGE_SIZE
|
static String |
PASSWORD
|
static String |
PATTERN
|
static String |
PORT
|
static String |
QUERY
|
static String |
TYPE
|
static String |
URI
|
static String |
USER
|
static String |
VERBOSE
|
Constructor Summary | |
XMLTools()
Constructor for XMLTools, includes default variables for the command line. |
Method Summary | |
boolean |
execute()
This method is to carry out execution, after instance variables being setup by process( args ) |
String |
getAction()
getAction returns the action type that will be passed to the command line tool. |
String |
getCollectionName()
getCollectionName returns the collection name that will be passed to the command line tool. |
protected org.w3c.dom.NodeList |
getCommands()
Returns the |
String |
getDatabaseServer()
getDatabaseServer returns the Database server that will be passed to the command line tool. |
String |
getDocumentName()
getDocumentName returns the document that will be passed to the command line tool. |
String |
getFilePath()
getFilePath returns the file path that will be passed to the command |
String |
getHost()
getPort returns the host that will be passed to the command line tool. |
String |
getImplementClass()
getImplementClass returns the implmented class path that will be passed to the command line tool. |
String |
getName()
getName returns the name for XMLObjects that will be passed to the command line tool. |
String |
getPassword()
getPassword returns the password that will be passed to the command line tool and will be used in conjunction with the userName value. |
String |
getPort()
getPort returns the port that will be passed to the command line tool. |
String |
getQuery()
getQuery returns the Query for Document passed to the command line tool. |
String |
getURI()
getURI gets returns the database URI (protocol://host:port/name) that will be passed to the command line tool |
String |
getUser()
getUser returns the user that will be passed to the command line tool and will be used in Security issues. |
boolean |
handleOption(String option,
ArgTokenizer at)
|
void |
init()
Carries out necessary initialization of this class. |
boolean |
isVerbose()
|
static void |
main(String[] args)
|
protected void |
parseArguments(String[] args)
Parses and validated the arguments of the command line. |
void |
process(String[] args)
The Process function is designed for the implementation of the command line tools, as well as, making the command line easier to use. |
void |
setAction(String actionType)
setAction sets the action type that will be passed to the command line. |
void |
setCollectionName(String collectionName)
setCollectionName sets the collection name that will be passed to the command line. |
void |
setDatabaseServer(String appName)
setDatabaseServer sets the Database server name that will be passed to the command line tool. |
void |
setDocumentName(String documentName)
setDocumentName sets the document that will be passed to the command line tool. |
void |
setFilePath(String fPath)
setFilePath sets the file path that will passed to the command line tool. |
void |
setHost(String hostName)
setHost sets the host that will passed to the command line tool. |
void |
setImplementClass(String imClassName)
setImplementClass sets the implemented class path that will be passed to the command line tool. |
void |
setName(String name)
setName sets the name for XMLObjects passed to the command line tool. |
void |
setPassword(String pswd)
setPassword sets the password that will be passed to the command line tool and will be used in conjunction with the userName value. |
void |
setPort(String portName)
setPort sets the port that will passed to the command line tool. |
void |
setQuery(String query)
setQuery sets the Query variable for Document Query from the command line. |
void |
setURI(String URI)
setURI sets the database URI (protocol://host:port/name) that will be passed to the command line |
void |
setUser(String userName)
setUser sets the user that will be passed to the command line tool and will be used in Security issues. |
void |
setVerbose(boolean verbose)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String COLLECTION
public static final String FILER
public static final String EXTENSION
public static final String FILE_PATH
public static final String ACTION
public static final String NAME_OF
public static final String PATTERN
public static final String QUERY
public static final String URI
public static final String VERBOSE
public static final String TYPE
public static final String PAGE_SIZE
public static final String MAX_KEY_SIZE
public static final String DB_SERVER
public static final String PORT
public static final String HOST
public static final String USER
public static final String LOCAL
public static final String DB_CONFIG
public static final String PASSWORD
public static final String AUTO_KEY
public static final String NAMESPACES
public static final String IMPL_CLASS
public static final String COMMAND_LIST
public static final String PAGE_COUNT
Constructor Detail |
public XMLTools()
Method Detail |
public static void main(String[] args)
public void init() throws XindiceException, FileNotFoundException
protected org.w3c.dom.NodeList getCommands()
public void process(String[] args) throws XindiceException
protected void parseArguments(String[] args) throws IllegalArgumentException
IllegalArgumentException
- if an error is foundpublic boolean execute() throws Exception
public boolean handleOption(String option, ArgTokenizer at)
public void setVerbose(boolean verbose)
verbose
- new value of verbose modepublic boolean isVerbose()
public void setAction(String actionType)
actionType
- The action valuepublic String getAction()
public void setCollectionName(String collectionName)
collectionName
- The collection valuepublic String getCollectionName()
public void setDocumentName(String documentName)
documentName
- The docName valuepublic String getDocumentName()
public void setQuery(String query)
query
- - The query stringpublic String getQuery()
public void setName(String name)
name
- The docName valuepublic String getName()
public void setDatabaseServer(String appName)
appName
- The dbServ valuepublic String getDatabaseServer()
public void setPort(String portName)
portName
- The port valuepublic String getPort()
public void setHost(String hostName)
hostName
- The host valuepublic String getHost()
public void setFilePath(String fPath)
fPath
- The filePath valuepublic String getFilePath()
public void setURI(String URI)
URI
- The URI for the databasepublic String getURI()
public void setImplementClass(String imClassName)
imClassName
- The implClass valuepublic String getImplementClass()
public void setUser(String userName)
userName
- The user valuepublic String getUser()
public void setPassword(String pswd)
pswd
- The passwrd valuepublic String getPassword()
|
Xindice API version 1.1 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |