JACK 5.4 JACOB Application Interface

aos.apib
Class InStream

java.lang.Object
  extended byaos.apib.BaseStream
      extended byaos.apib.InStream
Direct Known Subclasses:
AsciiInStream, BinaryInStream, JDBCInStream, SetStream

public abstract class InStream
extends aos.apib.BaseStream

InStream is a base class for JACOB input filtering.

See Also:
Serialized Form

Constructor Summary
InStream(TypeDict d)
          Constructs an InStream for a given TypeDict.
 
Method Summary
 void close()
          Closes the source stream.
static Base fromGZIP(byte[] b, TypeDict d)
           
abstract  Aggregate getAggregate(Aggregate a, StreamerSupport[] allowed)
           
abstract  Base[] getAggregate(StreamerSupport s, StreamerSupport[] allowed)
           
abstract  boolean getBool()
           
abstract  byte getByte()
           
abstract  char getChar()
           
abstract  byte[] getData()
           
abstract  double getDouble()
           
abstract  int getEnum(aos.apib.EnumInfo n)
           
 java.lang.String getFilename()
           
abstract  float getFloat()
           
abstract  int getInt()
           
abstract  long getLong()
           
abstract  Base getObject(StreamerSupport[] allowed)
           
abstract  java.lang.Object getOther(StreamerSupport[] allowed)
           
abstract  short getShort()
           
abstract  java.lang.String getString(boolean allowmultiline)
           
static InStream newAsciiInStream(java.io.InputStream fd, TypeDict d)
          Creates an AsciiInStream for a given InputStream and TypeDict.
static InStream newAsciiInStream(MemoryBuffer mb, TypeDict d)
           
static InStream newBinaryInStream(java.io.InputStream fd, TypeDict d)
          Creates a BinaryInStream for a given InputStream and TypeDict.
static InStream newBinaryInStream(MemoryBuffer mb, TypeDict d)
           
 Base notifyReadResolver(Base obj)
           
static InStream open(java.io.InputStream fd)
          Creates an appropriate InStream for a given InputStream and TypeDict.
static InStream open(java.io.InputStream fd, TypeDict d)
           
static InStream open(java.lang.String spec)
           
static InStream open(java.lang.String spec, TypeDict d)
          Creates an appropriate InStream for a given source specifier and TypeDict.
 void readBaseClasses(Base o, StreamerSupport s, int n)
           
 BaseList readMultipleObjects()
           
abstract  Base readObject()
          Reads a JACOB Object tree using the current TypeDict.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InStream

public InStream(TypeDict d)
Constructs an InStream for a given TypeDict. This constructor can only be used by InStream extensions that handle specific source types.

Method Detail

close

public void close()
Closes the source stream.


open

public static InStream open(java.lang.String spec)

open

public static InStream open(java.lang.String spec,
                            TypeDict d)
Creates an appropriate InStream for a given source specifier and TypeDict. The appropriate kind of InStream is determined by interpreting the source specifier (a1), and looking into the source. Currently three kinds of sources are supported:
Binary transport file
If the specifier names a file that contains JACOB binary transport data.
Textual transport file
If the specifier names a file that contains JACOB textual transport data.
SQL transport through JDBC
If the specifier has the form "jdbc:xxx" where xxx is a JDBCInStream specification.


open

public static InStream open(java.io.InputStream fd)
Creates an appropriate InStream for a given InputStream and TypeDict. The appropriate kind of InStream is determined by looking into the source. Currently two kinds of sources are supported:
Binary transport file
If the specifier names a file that contains JACOB binary transport data.
Textual transport file
If the specifier names a file that contains JACOB textual transport data.


open

public static InStream open(java.io.InputStream fd,
                            TypeDict d)

newAsciiInStream

public static final InStream newAsciiInStream(java.io.InputStream fd,
                                              TypeDict d)
Creates an AsciiInStream for a given InputStream and TypeDict.


newBinaryInStream

public static final InStream newBinaryInStream(java.io.InputStream fd,
                                               TypeDict d)
Creates a BinaryInStream for a given InputStream and TypeDict.


newAsciiInStream

public static final InStream newAsciiInStream(MemoryBuffer mb,
                                              TypeDict d)

newBinaryInStream

public static final InStream newBinaryInStream(MemoryBuffer mb,
                                               TypeDict d)

readBaseClasses

public void readBaseClasses(Base o,
                            StreamerSupport s,
                            int n)

readObject

public abstract Base readObject()
Reads a JACOB Object tree using the current TypeDict.


readMultipleObjects

public BaseList readMultipleObjects()

notifyReadResolver

public Base notifyReadResolver(Base obj)

getChar

public abstract char getChar()

getBool

public abstract boolean getBool()

getByte

public abstract byte getByte()

getShort

public abstract short getShort()

getInt

public abstract int getInt()

getLong

public abstract long getLong()

getString

public abstract java.lang.String getString(boolean allowmultiline)

getFilename

public java.lang.String getFilename()

getEnum

public abstract int getEnum(aos.apib.EnumInfo n)

getFloat

public abstract float getFloat()

getDouble

public abstract double getDouble()

getData

public abstract byte[] getData()

getObject

public abstract Base getObject(StreamerSupport[] allowed)

getOther

public abstract java.lang.Object getOther(StreamerSupport[] allowed)

getAggregate

public abstract Base[] getAggregate(StreamerSupport s,
                                    StreamerSupport[] allowed)

getAggregate

public abstract Aggregate getAggregate(Aggregate a,
                                       StreamerSupport[] allowed)

fromGZIP

public static Base fromGZIP(byte[] b,
                            TypeDict d)

JACK 5.4 JACOB Application Interface

Copyright (C) 1999-2008, Agent Oriented Software Pty. Ltd.

US Government Restricted Rights
The JACK Modules and relevant Software Material have been developed entirely at private expense and are accordingly provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of DFARS 252.227-7013 or subparagraph (c)(1) and (2) of the Commercial Computer Software Restricted Rights and 48 CFR 52.2270-19, as applicable.


Agent Oriented Software Pty. Ltd.     http://www.aosgrp.com
PO Box 639, Carlton South, Victoria 3053, Australia
Phone: +61 3 9349 5055, Fax: +61 3 9349 5088