Class Sofa

All Implemented Interfaces:
Cloneable, FeatureStructure, FeatureStructureImpl, SofaFSImpl, SofaFS

public class Sofa extends TOP implements SofaFSImpl
  • Field Details

  • Constructor Details

    • Sofa

      protected Sofa()
    • Sofa

      public Sofa(TypeImpl t, CASImpl c)
      used by generator, not used Make a new Sofa
      Parameters:
      t - -
      c - -
    • Sofa

      public Sofa(TypeImpl t, CASImpl c, int sofaNum, String viewName, String mimeType)
  • Method Details

    • getTypeIndexID

      public int getTypeIndexID()
      Overrides:
      getTypeIndexID in class TOP
      Returns:
      the type array index
    • getSofaNum

      public int getSofaNum()
      getter for sofaNum
      Specified by:
      getSofaNum in interface SofaFS
      Returns:
      the sofa number
    • getSofaID

      public String getSofaID()
      getter for sofaID
      Specified by:
      getSofaID in interface SofaFS
      Returns:
      the sofaID, which is the same as the view name
    • getMimeType

      public String getMimeType()
      getter for mimeType - gets
      Returns:
      the mime type
    • setLocalSofaData

      public void setLocalSofaData(FeatureStructure aFS)
      Description copied from interface: SofaFS
      Set the Local Subject of Analysis to be a predefined ArrayFS. Once set, the Sofa data cannot be changed.
      Specified by:
      setLocalSofaData in interface SofaFS
      Parameters:
      aFS - the SofA
      See Also:
    • setLocalSofaData

      public void setLocalSofaData(FeatureStructure aFS, String mimeType)
    • setLocalSofaData

      public void setLocalSofaData(String aString)
      Description copied from interface: SofaFS
      Set the Local Subject of Analysis to be a String. Once set, the Sofa data cannot be changed.
      Specified by:
      setLocalSofaData in interface SofaFS
      Parameters:
      aString - The subject of analysis
      See Also:
    • setLocalSofaDataNoDocAnnotUpdate

      public void setLocalSofaDataNoDocAnnotUpdate(String aString)
      Internal use: used by deserializers
      Parameters:
      aString - the string to update
    • setLocalSofaData

      public void setLocalSofaData(String aString, String mimeType)
    • getLocalFSData

      public FeatureStructure getLocalFSData()
      Description copied from interface: SofaFS
      Get the Local Subject of Analysis returns null if not previously set.
      Specified by:
      getLocalFSData in interface SofaFS
      Returns:
      the local SofA
      See Also:
    • getLocalStringData

      public String getLocalStringData()
      Description copied from interface: SofaFS
      Get the Local Subject of Analysis returns null if not previously set.
      Specified by:
      getLocalStringData in interface SofaFS
      Returns:
      the SofA
      See Also:
    • setRemoteSofaURI

      public void setRemoteSofaURI(String aURI)
      Description copied from interface: SofaFS
      Set the URI for a Remote Subject of Analysis. Once set, this URI may not be changed.
      Specified by:
      setRemoteSofaURI in interface SofaFS
      Parameters:
      aURI - the URI for a remote Sofa
      See Also:
    • setRemoteSofaURI

      public void setRemoteSofaURI(String aURI, String mimeType)
    • isSofaDataSet

      public boolean isSofaDataSet()
    • getSofaMime

      public String getSofaMime()
      Description copied from interface: SofaFS
      Get the Sofa mime type.
      Specified by:
      getSofaMime in interface SofaFS
      Returns:
      SofA mime type
    • getSofaURI

      public String getSofaURI()
      Description copied from interface: SofaFS
      Get the Sofa URI value.
      Specified by:
      getSofaURI in interface SofaFS
      Returns:
      Sofa URI or null if not valid
    • getSofaRef

      public int getSofaRef()
      Description copied from interface: SofaFS
      Get the Sofa Ref value.
      Specified by:
      getSofaRef in interface SofaFS
      Returns:
      the Sofa Reference value
    • getSofaDataStream

      public InputStream getSofaDataStream()
      Description copied from interface: SofaFS
      Provides stream access to both local and remote Sofa data. For remote SofA data, a custom URLStreamHandler may be registered for a protocol via the java.protocol.handler.pkgs system property.
      Specified by:
      getSofaDataStream in interface SofaFS
      Returns:
      an InputStream for reading Sofa data. null returned if there is no Sofa data.
    • getSofaArray

      public TOP getSofaArray()
      These getter methods are for creating method handle access The getter name must match the feature name + transformation - used in generic pretty printing routines
      Returns:
      -
    • getSofaString

      public String getSofaString()
    • setStringValue

      public void setStringValue(Feature feat, String val)
      Description copied from interface: FeatureStructure
      Set the string value of a feature.
      Specified by:
      setStringValue in interface FeatureStructure
      Overrides:
      setStringValue in class FeatureStructureImplC
      Parameters:
      feat - The feature whose value we want to set.
      val - The string we're setting the feature to.
    • setFeatureValue

      public void setFeatureValue(Feature feat, FeatureStructure fs)
      Description copied from interface: FeatureStructure
      Set a feature value to another FS.
      Specified by:
      setFeatureValue in interface FeatureStructure
      Overrides:
      setFeatureValue in class FeatureStructureImplC
      Parameters:
      feat - The feature whose value should be set.
      fs - The value FS.
    • setIntValue

      public void setIntValue(Feature feat, Integer val)
    • throwAlreadySet

      private void throwAlreadySet(String msg)
    • setMimeType

      public void setMimeType(String v)