org.basex.io

Class IO

java.lang.Object

org.basex.io.IO

Direct Known Subclasses:

IOContent, IOFile, IOUrl

public abstract class IO
extends java.lang.Object

Generic representation for inputs and outputs. The underlying source can be a local file (IOFile), a URL (IOUrl) or a byte array (IOContent).

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASEXSUFFIX Database file suffix.
static int	BLOCKSIZE Disk block/page size (default: 4096).
static java.lang.String	CSVSUFFIX CSV file suffix.
static java.text.SimpleDateFormat	DATE Date format which is appended to backups.
static java.lang.String	DATEPATTERN Date pattern.
static int	ENTRIES Entries per block (default: 256).
static java.lang.String	FILEPREF File prefix.
static java.lang.String	GZSUFFIX GZIP file suffix.
static java.lang.String[]	HTMLSUFFIXES HTML suffixes.
static java.lang.String	JSONSUFFIX JSON file suffix.
static int	MAXATTS Maximum number of attributes (see bit layout in Data class).
static int	NODEPOWER Table node size power (default: 4).
static int	NODESIZE Table node size power (default: 4).
static long	OFFCOMP Offset for compressing texts (see bit layout in Data class).
static long	OFFNUM Offset for inlining numbers (see bit layout in Data class).
static java.lang.String[]	TXTSUFFIXES Text suffixes.
static java.lang.String	XARSUFFIX XAR file suffix.
static java.lang.String	XMLSUFFIX XML file suffix.
static java.lang.String[]	XMLSUFFIXES XML suffixes.
static java.lang.String	XQMSUFFIX XQuery module suffix.
static java.lang.String	XQSUFFIX XQuery file suffix.
static java.lang.String[]	XQSUFFIXES XQuery suffixes.
static java.lang.String	ZIPSUFFIX ZIP file suffix.
static java.lang.String[]	ZIPSUFFIXES ZIP suffixes.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	dbname() Chops the path and the file suffix of the specified filename and returns the database name.
java.lang.String	dir() Returns the directory.
boolean	eq(IO io) Compares the filename of the specified IO reference.
boolean	exists() Tests if the file exists.
static IO	get(java.lang.String source) Returns a class instance for the specified string.
abstract org.xml.sax.InputSource	inputSource() Returns an input source.
abstract java.io.InputStream	inputStream() Returns an input stream.
boolean	isArchive() Checks if this file is an archive.
boolean	isDir() Tests if this is a directory instance.
boolean	isXML() Checks if this file contains XML.
abstract long	length() Returns the file length.
abstract IO	merge(java.lang.String fn) Merges two filenames.
boolean	more(boolean archive) Checks if more input streams are found.
java.lang.String	name() Returns the name of the resource.
void	name(java.lang.String n) Sets the name of the resource.
java.lang.String	path() Returns the path.
abstract byte[]	read() Returns the contents.
long	timeStamp() Returns the modification date of this file.
java.lang.String	toString()
java.lang.String	url() Creates a URL from the specified path.

Methods inherited from class java.lang.Object

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

Field Detail

BASEXSUFFIX

public static final java.lang.String BASEXSUFFIX

Database file suffix.

See Also:

Constant Field Values

XQSUFFIX

public static final java.lang.String XQSUFFIX

XQuery file suffix.

See Also:

Constant Field Values

XQMSUFFIX

public static final java.lang.String XQMSUFFIX

XQuery module suffix.

See Also:

Constant Field Values

XMLSUFFIX

public static final java.lang.String XMLSUFFIX

XML file suffix.

See Also:

Constant Field Values

ZIPSUFFIX

public static final java.lang.String ZIPSUFFIX

ZIP file suffix.

See Also:

Constant Field Values

CSVSUFFIX

public static final java.lang.String CSVSUFFIX

CSV file suffix.

See Also:

Constant Field Values

JSONSUFFIX

public static final java.lang.String JSONSUFFIX

JSON file suffix.

See Also:

Constant Field Values

GZSUFFIX

public static final java.lang.String GZSUFFIX

GZIP file suffix.

See Also:

Constant Field Values

XARSUFFIX

public static final java.lang.String XARSUFFIX

XAR file suffix.

See Also:

Constant Field Values

FILEPREF

public static final java.lang.String FILEPREF

File prefix.

See Also:

Constant Field Values

DATE

public static final java.text.SimpleDateFormat DATE

Date format which is appended to backups.

DATEPATTERN

public static final java.lang.String DATEPATTERN

Date pattern.

See Also:

Constant Field Values

XQSUFFIXES

public static final java.lang.String[] XQSUFFIXES

XQuery suffixes.

ZIPSUFFIXES

public static final java.lang.String[] ZIPSUFFIXES

ZIP suffixes.

XMLSUFFIXES

public static final java.lang.String[] XMLSUFFIXES

XML suffixes.

HTMLSUFFIXES

public static final java.lang.String[] HTMLSUFFIXES

HTML suffixes.

TXTSUFFIXES

public static final java.lang.String[] TXTSUFFIXES

Text suffixes.

BLOCKSIZE

public static final int BLOCKSIZE

Disk block/page size (default: 4096).

See Also:

Constant Field Values

NODEPOWER

public static final int NODEPOWER

Table node size power (default: 4).

See Also:

Constant Field Values

NODESIZE

public static final int NODESIZE

Table node size power (default: 4).

See Also:

Constant Field Values

ENTRIES

public static final int ENTRIES

Entries per block (default: 256).

See Also:

Constant Field Values

MAXATTS

public static final int MAXATTS

Maximum number of attributes (see bit layout in Data class).

See Also:

Constant Field Values

OFFNUM

public static final long OFFNUM

Offset for inlining numbers (see bit layout in Data class).

See Also:

Constant Field Values

OFFCOMP

public static final long OFFCOMP

Offset for compressing texts (see bit layout in Data class).

See Also:

Constant Field Values

Method Detail

get

public static IO get(java.lang.String source)

Returns a class instance for the specified string. The type of the returned instance depends on the string value:

• IOContent: if the string starts with an angle bracket (<) or if it is a null reference, it is interpreted as XML fragment and handled as byte array
• IOFile: if the string starts with file:, or if it does not contain the substring ://, it is interpreted as local file instance
• IOUrl: otherwise, it is handled as URL

If the content of the string value is known in advance, it is advisable to call the direct constructors of the correspondent sub class.

Parameters:

source - source string

Returns:

IO reference

read

public abstract byte[] read()
                     throws java.io.IOException

Returns the contents.

Returns:

contents

Throws:

java.io.IOException - I/O exception

exists

public boolean exists()

Tests if the file exists. Returns true by default.

Returns:

result of check

isDir

public boolean isDir()

Tests if this is a directory instance.

Returns:

result of check

timeStamp

public long timeStamp()

Returns the modification date of this file.

Returns:

modification date

length

public abstract long length()

Returns the file length.

Returns:

file length

more

public boolean more(boolean archive)
             throws java.io.IOException

Checks if more input streams are found.

Parameters:

archive - parse archives

Returns:

result of check

Throws:

java.io.IOException - I/O exception

inputSource

public abstract org.xml.sax.InputSource inputSource()

Returns an input source.

Returns:

input source

inputStream

public abstract java.io.InputStream inputStream()
                                         throws java.io.IOException

Returns an input stream.

Returns:

input stream

Throws:

java.io.IOException - I/O exception

merge

public abstract IO merge(java.lang.String fn)

Merges two filenames.

Parameters:

fn - file name/path to be appended

Returns:

resulting reference

isArchive

public boolean isArchive()

Checks if this file is an archive.

Returns:

result of check

isXML

public boolean isXML()

Checks if this file contains XML.

Returns:

result of check

dbname

public final java.lang.String dbname()

Chops the path and the file suffix of the specified filename and returns the database name.

Returns:

database name

name

public final java.lang.String name()

Returns the name of the resource.

Returns:

file name

name

public final void name(java.lang.String n)

Sets the name of the resource.

Parameters:

n - file name

path

public final java.lang.String path()

Returns the path. The path uses forward slashes, no matter which OS is used.

Returns:

path

url

public java.lang.String url()

Creates a URL from the specified path.

Returns:

URL

dir

public java.lang.String dir()

Returns the directory.

Returns:

chopped filename

eq

public final boolean eq(IO io)

Compares the filename of the specified IO reference.

Parameters:

io - io reference

Returns:

result of check

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object