Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

oracle.javatools.db
Class FileSpecification

java.lang.Object
  extended by oracle.javatools.db.AbstractDBObject
      extended by oracle.javatools.db.AbstractChildDBObject
          extended by oracle.javatools.db.FileSpecification
All Implemented Interfaces:
ChildDBObject, DBObject, Copyable, DynamicPropertySet

public class FileSpecification
extends AbstractChildDBObject

Model of File Specification properties. A file specification is used to represent data and temp files for Tablespace objects

Since:
11.1.1.2.0

Nested Class Summary
static class FileSpecification.FileStatus
           
 
Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject
AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport
 
Field Summary
static java.lang.String TYPE
           
 
Fields inherited from interface oracle.javatools.db.DBObject
COMMENT
 
Constructor Summary
FileSpecification()
           
FileSpecification(java.lang.String fileName)
           
 
Method Summary
 AutoExtendProperties getAutoExtendProperties()
          Return AUTO EXTEND properties
 java.lang.String getDirectory()
          Return file directory name
 java.math.BigInteger getFileSize()
          Return file SIZE in bytes
 FileSpecification.FileStatus getStatus()
          return online status of the file specification
 java.lang.String getType()
          Returns the type of this object.
 boolean isReuse()
          Return whether an existing filename should be re-used or not
 void setAutoExtendProperties(AutoExtendProperties autoExtendProperties)
          Set AUTO EXTEND properties
 void setDirectory(java.lang.String directory)
          Set file directory name
 void setFileSize(java.math.BigInteger fileSize)
          Set file SIZE (the amount of bytes storage required on the file system)
 void setReuse(boolean reuse)
          Set REUSE value.
 void setStatus(FileSpecification.FileStatus status)
          Set online status of file, either ONLINE or OFFLINE
 
Methods inherited from class oracle.javatools.db.AbstractChildDBObject
copyToImpl, findParent, getParent, getProperty, setParent, setProperty
 
Methods inherited from class oracle.javatools.db.AbstractDBObject
changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getProperties, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.javatools.db.DBObject
copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, replaceReferenceIDs, setID, setName
 
Methods inherited from interface oracle.javatools.util.DynamicPropertySet
getProperties, getProperty, setProperties
 

Field Detail

TYPE

public static final java.lang.String TYPE
See Also:
Constant Field Values
Constructor Detail

FileSpecification

public FileSpecification()

FileSpecification

public FileSpecification(java.lang.String fileName)
Method Detail

getType

public java.lang.String getType()
Description copied from interface: DBObject
Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Returns:
a string describing the type of object.

setDirectory

public void setDirectory(java.lang.String directory)
Set file directory name

Parameters:
directory - name of directory to store datafiles

getDirectory

public java.lang.String getDirectory()
Return file directory name

Returns:
directory name where file resides

setFileSize

public void setFileSize(java.math.BigInteger fileSize)
Set file SIZE (the amount of bytes storage required on the file system)

Parameters:
fileSize - size of file specification

getFileSize

public java.math.BigInteger getFileSize()
Return file SIZE in bytes

Returns:
size of file specification in bytes

setReuse

public void setReuse(boolean reuse)
Set REUSE value. If true then if a file of the given name already exists on the file system and is currently not in use by any other Tablespaces then reuse or create a new one. Used when the file specification is created and associated with a Tablespace

Parameters:
reuse - re-use given file name if true else false

isReuse

public boolean isReuse()
Return whether an existing filename should be re-used or not

Returns:
true if file should be re-used else false

setStatus

public void setStatus(FileSpecification.FileStatus status)
Set online status of file, either ONLINE or OFFLINE

Parameters:
status - online status of the file specification

getStatus

public FileSpecification.FileStatus getStatus()
return online status of the file specification

Returns:
online file status

setAutoExtendProperties

public void setAutoExtendProperties(AutoExtendProperties autoExtendProperties)
Set AUTO EXTEND properties

Parameters:
autoExtendProperties - auto extend properties

getAutoExtendProperties

public AutoExtendProperties getAutoExtendProperties()
Return AUTO EXTEND properties

Returns:
value of auto extend properties

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

Copyright © 1997, 2011, Oracle. All rights reserved.