Skip navigation links


com.essbase.eas.essbase.defs.outline
Class MemberAccessFile

java.lang.Object
  extended by com.essbase.eas.essbase.defs.outline.MemberAccessFile

Direct Known Subclasses:
DeleteMemberAccessFile, ExtendedShareMemberAccessFile, IndexMemberAccessFile

public class MemberAccessFile
extends java.lang.Object

Defines a class that can be used to read/write member objects to a file without using Java serialization and object streaming. This tends to write shorter files so not as much data is transmitted between client/server platforms. This class is designed to be used with the DefaultMember class and the DefaultMember and AccessibleMember interfaces.

Since:
7.1.0
Version:
7.1.0
Author:
Hank Cox

Field Summary
static int CURRENT_VERSION
          contains the current file version for transferring members.
static int MAX_USHORT_LEN
           

 

Constructor Summary
MemberAccessFile(java.io.File file, java.lang.String mode)
           
MemberAccessFile(java.lang.String name, java.lang.String mode)
           

 

Method Summary
 void addToFileList()
           
 void close()
           
 void closeAndDelete()
           
 Member createMember()
           
 Member createMember(int index, boolean loadData)
           
 java.lang.String getAbsolutePath()
           
 boolean getAliasesIncluded()
           
 boolean getAttributesIncluded()
           
 long getFilePointer()
           
 boolean getFormulasIncluded()
           
 int getMemberCount()
           
 long getOffsetForIndex(int index)
           
 long getOffsetForMember(AccessibleMember m)
           
 boolean getQueryMode()
           
 java.io.RandomAccessFile getRandomAccessFile()
           
 long getTimeStamp()
           
 boolean getUDASIncluded()
           
 int getVersion()
           
 void readHeader()
           
 int readInt()
           
 long readLong()
           
 short readShort()
           
 java.lang.String readUTF()
           
 void seek(long pos)
           
 void seekMember(AccessibleMember m)
           
 void setAliasesIncluded(boolean value)
           
 void setAttributesIncluded(boolean value)
           
 void setFormulasIncluded(boolean value)
           
 void setMemberCount(int value)
           
 void setQueryMode(boolean value)
           
 void setTimeStamp()
           
 void setUDASIncluded(boolean value)
           
static void updateTimeStamp(MemberAccessFile file)
           
 void writeInt(int v)
           
 void writeLong(long v)
           
 void writeShort(int v)
           
 void writeUTF(java.lang.String str)
           

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

MAX_USHORT_LEN

public static final int MAX_USHORT_LEN
See Also:
Constant Field Values

CURRENT_VERSION

public static final int CURRENT_VERSION
contains the current file version for transferring members.
See Also:
Constant Field Values

Constructor Detail

MemberAccessFile

public MemberAccessFile(java.io.File file,
                        java.lang.String mode)
                 throws java.io.FileNotFoundException
Throws:
java.io.FileNotFoundException

MemberAccessFile

public MemberAccessFile(java.lang.String name,
                        java.lang.String mode)
                 throws java.io.FileNotFoundException
Throws:
java.io.FileNotFoundException

Method Detail

getAbsolutePath

public java.lang.String getAbsolutePath()

getAliasesIncluded

public boolean getAliasesIncluded()

setAliasesIncluded

public void setAliasesIncluded(boolean value)

getAttributesIncluded

public boolean getAttributesIncluded()

setAttributesIncluded

public void setAttributesIncluded(boolean value)

getUDASIncluded

public boolean getUDASIncluded()

setUDASIncluded

public void setUDASIncluded(boolean value)

getFormulasIncluded

public boolean getFormulasIncluded()

setFormulasIncluded

public void setFormulasIncluded(boolean value)

getVersion

public int getVersion()

getMemberCount

public int getMemberCount()

setMemberCount

public void setMemberCount(int value)

getQueryMode

public boolean getQueryMode()

setQueryMode

public void setQueryMode(boolean value)

readHeader

public void readHeader()
                throws java.io.IOException
Throws:
java.io.IOException

getOffsetForMember

public long getOffsetForMember(AccessibleMember m)
                        throws java.io.IOException
Throws:
java.io.IOException

getOffsetForIndex

public long getOffsetForIndex(int index)
                       throws java.io.IOException
Throws:
java.io.IOException

seekMember

public void seekMember(AccessibleMember m)
                throws java.io.IOException
Throws:
java.io.IOException

createMember

public Member createMember()

createMember

public Member createMember(int index,
                           boolean loadData)
                    throws java.io.IOException
Throws:
java.io.IOException

closeAndDelete

public void closeAndDelete()

setTimeStamp

public void setTimeStamp()

getTimeStamp

public long getTimeStamp()

addToFileList

public void addToFileList()

updateTimeStamp

public static void updateTimeStamp(MemberAccessFile file)

readLong

public long readLong()
              throws java.io.IOException
Throws:
java.io.IOException

readInt

public int readInt()
            throws java.io.IOException
Throws:
java.io.IOException

readShort

public final short readShort()
                      throws java.io.IOException
Throws:
java.io.IOException

readUTF

public final java.lang.String readUTF()
                               throws java.io.IOException
Throws:
java.io.IOException

seek

public void seek(long pos)
          throws java.io.IOException
Throws:
java.io.IOException

close

public void close()
           throws java.io.IOException
Throws:
java.io.IOException

writeUTF

public void writeUTF(java.lang.String str)
              throws java.io.IOException
Throws:
java.io.IOException

writeShort

public final void writeShort(int v)
                      throws java.io.IOException
Throws:
java.io.IOException

writeInt

public final void writeInt(int v)
                    throws java.io.IOException
Throws:
java.io.IOException

writeLong

public final void writeLong(long v)
                     throws java.io.IOException
Throws:
java.io.IOException

getFilePointer

public long getFilePointer()
                    throws java.io.IOException
Throws:
java.io.IOException

getRandomAccessFile

public java.io.RandomAccessFile getRandomAccessFile()
                                             throws java.io.IOException
Throws:
java.io.IOException

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.