Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class Schema

    Abstract class representing a TSSL schema. Actual TSSL schemas are compiled into concrete subclasses of this class.

    Inheritance
    object
    Schema
    HTMLSchema
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: TagSoup
    Assembly: Lucene.Net.Benchmark.dll
    Syntax
    public abstract class Schema

    Fields

    F_CDATA

    Abstract class representing a TSSL schema. Actual TSSL schemas are compiled into concrete subclasses of this class.

    Declaration
    public const int F_CDATA = 2
    Field Value
    Type Description
    int

    F_NOFORCE

    Abstract class representing a TSSL schema. Actual TSSL schemas are compiled into concrete subclasses of this class.

    Declaration
    public const int F_NOFORCE = 4
    Field Value
    Type Description
    int

    F_RESTART

    Abstract class representing a TSSL schema. Actual TSSL schemas are compiled into concrete subclasses of this class.

    Declaration
    public const int F_RESTART = 1
    Field Value
    Type Description
    int

    M_ANY

    Abstract class representing a TSSL schema. Actual TSSL schemas are compiled into concrete subclasses of this class.

    Declaration
    public const int M_ANY = -1
    Field Value
    Type Description
    int

    M_EMPTY

    Abstract class representing a TSSL schema. Actual TSSL schemas are compiled into concrete subclasses of this class.

    Declaration
    public const int M_EMPTY = 0
    Field Value
    Type Description
    int

    M_PCDATA

    Abstract class representing a TSSL schema. Actual TSSL schemas are compiled into concrete subclasses of this class.

    Declaration
    public const int M_PCDATA = 1073741824
    Field Value
    Type Description
    int

    M_ROOT

    Abstract class representing a TSSL schema. Actual TSSL schemas are compiled into concrete subclasses of this class.

    Declaration
    public const int M_ROOT = -2147483648
    Field Value
    Type Description
    int

    Properties

    Prefix

    Gets ot sets the prefix of this schema.

    Declaration
    public virtual string Prefix { get; set; }
    Property Value
    Type Description
    string

    RootElementType

    Gets or sets the root element of this schema

    Declaration
    public virtual ElementType RootElementType { get; }
    Property Value
    Type Description
    ElementType

    Uri

    Gets or sets the URI (namespace name) of this schema.

    Declaration
    public virtual string Uri { get; set; }
    Property Value
    Type Description
    string

    Methods

    Attribute(string, string, string, string)

    Add or replace a default attribute for an element type in this schema.

    Declaration
    public virtual void Attribute(string elemName, string attrName, string type, string value)
    Parameters
    Type Name Description
    string elemName

    Name (Qname) of the element type

    string attrName

    Name (Qname) of the attribute

    string type

    Type of the attribute

    string value

    Default value of the attribute; null if no default

    ElementType(string, int, int, int)

    Add or replace an element type for this schema.

    Declaration
    public virtual void ElementType(string name, int model, int memberOf, int flags)
    Parameters
    Type Name Description
    string name

    Name (Qname) of the element

    int model

    Models of the element's content as a vector of bits

    int memberOf

    Models the element is a member of as a vector of bits

    int flags

    Flags for the element

    Entity(string, int)

    Add to or replace a character entity in this schema.

    Declaration
    public virtual void Entity(string name, int value)
    Parameters
    Type Name Description
    string name

    Name of the entity

    int value

    Value of the entity

    GetElementType(string)

    Get an ElementType by name.

    Declaration
    public virtual ElementType GetElementType(string name)
    Parameters
    Type Name Description
    string name

    Name (Qname) of the element type

    Returns
    Type Description
    ElementType

    The corresponding ElementType

    GetEntity(string)

    Get an entity value by name.

    Declaration
    public virtual int GetEntity(string name)
    Parameters
    Type Name Description
    string name

    Name of the entity

    Returns
    Type Description
    int

    The corresponding character, or 0 if none

    Parent(string, string)

    Specify natural parent of an element in this schema.

    Declaration
    public virtual void Parent(string name, string parentName)
    Parameters
    Type Name Description
    string name

    Name of the child element

    string parentName

    Name of the parent element

    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.