oracle.ifs.beans.parsers

Class ClassSelectionParser

java.lang.Object

oracle.ifs.beans.parsers.ClassSelectionParser

All Implemented Interfaces:

Parser

Deprecated.

iFS 9.0.3 - cannot delete cause CUP still uses

@Deprecated
public class ClassSelectionParser
extends Object
implements Parser

The ClassSelectionParser.java class sets the correct classname when creating a Document. Enabling creation of Document subclasses through the parsing framework.

Version:

1.0

Author:

Kevin Gillett

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected FolderPathResolver	m_fpr Deprecated. for path verification
protected LibrarySession	m_session Deprecated. the session
static String	PROPERTY_BUNDLE_NAME Deprecated.

Fields inherited from interface oracle.ifs.beans.parsers.Parser

CURRENT_NAME_OPTION, CURRENT_PATH_OPTION, DOCUMENT_CHARSET_OPTION, DOCUMENT_LANGUAGE_OPTION, LITERAL_DOCUMENT_OPTION, UPDATE_OBJECT_OPTION, VALIDATE_DOCUMENT_OPTION

Constructor Summary

Constructors

Constructor and Description
ClassSelectionParser(LibrarySession session) Deprecated. Constructs a ClassSelectionParser

Method Summary

Modifier and Type	Method and Description
protected Document	createDocument(Folder parent, DocumentDefinition def, String name, String classname, ParserCallback callback) Deprecated. Encapsulates document creation given a parent folder, a name, Document subclass classname, and an stream/reader; will not update a prior existing object in parent, will throw an IfsException simply because an object already exists in parent with name
protected String	getClassname(String filename) Deprecated. Deternmines the classname of the Document based on the filename extension.
protected DocumentDefinition	getDocDef(Folder parent, InputStream in, String name) Deprecated. Defines what it means to be a plain non versioned doc
protected DocumentDefinition	getDocDef(Folder parent, Reader reader, String name) Deprecated. Defines what it means to be a plain non versioned doc
LibraryObject	parse(InputStream stream, ParserCallback callback, Hashtable options) Deprecated. Use the stream as the content of a Document subclass based on the Parser.CURRENT_NAME_OPTION.
LibraryObject	parse(Reader reader, ParserCallback callback, Hashtable options) Deprecated. Use the reader as the content of a Document subclass based on the Parser.CURRENT_NAME_OPTION.
protected PublicObject	putPublicObjectWithVersioning(Folder parent, DocumentDefinition def, String name, String classname, ParserCallback callback) Deprecated. Encapsulates the ftpish notion of a put given a parent folder, a name, and an stream/reader; will create or update existing PO depending prior existence of an object in parent, if creating an object of class classname is created.
protected Document	updateFolderedPublicObjectWithVersioning(Folder parent, DocumentDefinition def, String name, String classname, ParserCallback callback) Deprecated. encapsulates the item update given a parent folder, a name, and an stream/reader; will update a prior existing object in parent, will throw an IfsException simply because an object doesn't exist in parent

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_BUNDLE_NAME

public static final String PROPERTY_BUNDLE_NAME

Deprecated.

See Also:

Constant Field Values

m_session

protected LibrarySession m_session

Deprecated.

the session

m_fpr

protected FolderPathResolver m_fpr

Deprecated.

for path verification

(Unpublished)

Constructor Detail

ClassSelectionParser

public ClassSelectionParser(LibrarySession session)
                     throws IfsException

Deprecated.

Constructs a ClassSelectionParser

Throws:

IfsException

Method Detail

getClassname

protected String getClassname(String filename)

Deprecated.

Deternmines the classname of the Document based on the filename extension.

parse

public LibraryObject parse(InputStream stream,
                           ParserCallback callback,
                           Hashtable options)
                    throws IfsException

Deprecated.

Use the stream as the content of a Document subclass based on the Parser.CURRENT_NAME_OPTION. Both the PARSER.CURRENT_NAME_OPTION and the Parser.CURRENT_PATH_OPTION must be set in the options Hashtable.

Specified by:

parse in interface Parser

Parameters:

stream - the content

callback - the callback

options - the options

Returns:

The primary object created. If there is only one top level object then this is returned. If no object is "primary" then null is returned.

Throws:

IfsException - (IFS-12601) if the operation fails

parse

public LibraryObject parse(Reader reader,
                           ParserCallback callback,
                           Hashtable options)
                    throws IfsException

Deprecated.

Use the reader as the content of a Document subclass based on the Parser.CURRENT_NAME_OPTION. Both the PARSER.CURRENT_NAME_OPTION and the Parser.CURRENT_PATH_OPTION must be set in the options Hashtable.

Specified by:

parse in interface Parser

Parameters:

reader - the content

callback - the callback

options - the options

Returns:

The primary object created. If there is only one top level object then this is returned. If no object is "primary" then null is returned.

Throws:

IfsException - (IFS-12602) if the operation fails

putPublicObjectWithVersioning

protected PublicObject putPublicObjectWithVersioning(Folder parent,
                                                     DocumentDefinition def,
                                                     String name,
                                                     String classname,
                                                     ParserCallback callback)
                                              throws IOException,
                                                     IfsException

Deprecated.

Encapsulates the ftpish notion of a put given a parent folder, a name, and an stream/reader; will create or update existing PO depending prior existence of an object in parent, if creating an object of class classname is created. will not throw an IfsException simply because an object does or doesn't exist at the path, but will throw if folders in path do not exist; may throw if world changes in terms of items in the folder during call

Parameters:

parent - the folder where the item goes

def - the DocumentDefinition

name - the name of the item

classname - the classname of the new object, must be Document.CLASS_NAME or a subclass of Document

callback - the callback

Returns:

PublicObject the object foldered at parent.name

Throws:

IOException

IfsException

updateFolderedPublicObjectWithVersioning

protected Document updateFolderedPublicObjectWithVersioning(Folder parent,
                                                            DocumentDefinition def,
                                                            String name,
                                                            String classname,
                                                            ParserCallback callback)
                                                     throws IfsException,
                                                            IOException

Deprecated.

encapsulates the item update given a parent folder, a name, and an stream/reader; will update a prior existing object in parent, will throw an IfsException simply because an object doesn't exist in parent

Parameters:

parent - the folder where the item goes

def - the DocumentDefinition

name - the name of the item

callback - the callback

Returns:

returns the PO referenced by the path

Throws:

IfsException

IOException

createDocument

protected Document createDocument(Folder parent,
                                  DocumentDefinition def,
                                  String name,
                                  String classname,
                                  ParserCallback callback)
                           throws IfsException,
                                  IOException

Deprecated.

Encapsulates document creation given a parent folder, a name, Document subclass classname, and an stream/reader; will not update a prior existing object in parent, will throw an IfsException simply because an object already exists in parent with name

Parameters:

parent - the folder where the item goes

def - the DocumentDefinition

name - the name of the document

classname - the Document subclass classname

callback - the callback

Throws:

IfsException

IOException

getDocDef

protected DocumentDefinition getDocDef(Folder parent,
                                       InputStream in,
                                       String name)
                                throws IfsException

Deprecated.

Defines what it means to be a plain non versioned doc

Throws:

IfsException

getDocDef

protected DocumentDefinition getDocDef(Folder parent,
                                       Reader reader,
                                       String name)
                                throws IfsException

Deprecated.

Defines what it means to be a plain non versioned doc

Throws:

IfsException