TextStreamInterface Class Reference

Inheritance diagram for TextStreamInterface:

Collaboration diagram for TextStreamInterface:

Static Public Attributes
	LANGUAGECLASS = None
	SIMILARITYINDEX = None
	Specify the <PARAMETER>SIMILARITYINDEX</PARAMETER> parameter when you intend to use. More...
Static Public Attributes inherited from Stream
	CONTENT = None
	This is the property class for properties whose type class is a stream. More...
	ENCODING = None
	Encoding to be used for XML serialization of a binary stream.
	ESCAPE = None
	Controls the translate table used to escape content when CONTENT="MIXED" is specified.
	LOCATION = None
	If STORAGE is "GLOBAL", this is the global node reference where the stream data is stored. More...
	MTOM = None
	If MTOM is true, then the property that references this binary stream is available for optimization. More...
	STORAGE = None
	This is the storage type of the stream - GLOBAL or OTHER.
Static Public Attributes inherited from Object
	CLASSNAME = None
	Property superclass for object values, for internal use only. More...
Static Public Attributes inherited from Literal
	CALCSELECTIVITY = None
	Property class for literal values, for internal use only. More...
	CAPTION = None
	A caption for the property usually used by client applications.
	EXTERNALSQLNAME = None
	The name of the column in an external SQL table (gateway) to which this property is linked.
	EXTERNALSQLTYPE = None
	The original type of the column in an external SQL table (gateway) to which this property is linked.
	JAVATYPE = None
	The Java type to be used when exported.
	STORAGEDEFAULT = None
	STORAGEDEFAULT is the type of storage used for the property if it is not already. More...

Additional Inherited Members
Public Member Functions inherited from StreamEmbedded
_.Library.Status	Set (_.Library.RawString newvalue)
	Set the property to an oref value. More...
Public Member Functions inherited from Stream
_.Library.ObjectIdentity	GetObject (_.Library.Integer force)
	This method obtains the state/id of the referenced object if swizzling has not occurred, it simply returns the stored. More...
_.Library.RegisteredObject	GetSwizzled (_.Library.Boolean noswizzle)
	returns an oref, performing swizzling if necessary it returns "" ($$$NULLOREF) if there is no oref and the id="" More...
_.Library.Status	SetFromShardStream (_.Library.RawString newvalue)
	This method is used when loading an object for a sharded class and getting the stream from the shard-local class. More...
Public Member Functions inherited from Object
_.Library.RawString	Get ()
	Returns an oref, performing swizzling if necessary. More...
_.Library.String	GetObjectId (_.Library.Integer force)
	Stores simply calls GetObject() with decomposes Oid into Id.
_.Library.Integer	IsEmpty ()
	Can be used to test whether an embedded object is in. More...
_.Library.ObjectHandle	NewObject ()
	Creates a new object for the referenced property.
_.Library.Status	SetObject (_.Library.ObjectIdentity newvalue)
	Stores a new value for the OID of the referenced. More...
_.Library.Status	SetObjectId (_.Library.String newid)
	Stores simply calls SetObject() with constructed Oid.
Static Public Member Functions inherited from StreamEmbedded
_.Library.Status	GetValueArray (_.Library.Binary pStream, _.Library.Binary pValueArray)
	Stream property class for streams that cannot be independent entities as instances of such stream classes can only exist within a container object.

Member Data Documentation

LANGUAGECLASS

LANGUAGECLASS = None

static

The <PARAMETER>LANGUAGECLASS</PARAMETER> parameter specifies the fully qualified name of the language

implementation class. Optionally, he <PARAMETER>LANGUAGECLASS</PARAMETER> may be set to the name of a global that indirectly defines the language class name. If a global name is specified, then the global must be defined and available at index build time and at SQL query execution time.

SIMILARITYINDEX

SIMILARITYINDEX = None

static

Specify the <PARAMETER>SIMILARITYINDEX</PARAMETER> parameter when you intend to use.

the SIMILARITY SQL operator to rank query results by relevance.

The <PARAMETER>SIMILARITYINDEX</PARAMETER> parameter specifies the name of an index on the current property that has the structure expected by the SimilarityIdx class method of the class specified in the LANGUAGECLASS parameter. The SimilarityIdx class method in the Text.Text class requires the index global to have the structure: ^textIndexGlobal([constantSubscripts,]key,ID) = value. An index with this structure can be created by compiling an index specification such as:

PROPERTY myDocument As User.TextStream (LANGUAGECLASS = "%Text.English", SIMILARITYINDEX = "myIndex"); INDEX myIndex ON myDocument(KEYS) DATA [ myDocument(VALUES) ];

The SimilarityIdx method of the Text.Text class requires the index specified in the SIMILARITYINDEX parameter to have exactly this structure. The index may not be a bitmap index, additional subscripts or data values may not be added to the Index specification, and the index must inherit the collation of the property.