Package org.apache.manifoldcf.crawler.connectors.filenet

Class DocClassSpec

  • public class DocClassSpec
extends java.lang.Object

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      protected static class  DocClassSpec.MatchItem  

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _rcsid  
      protected boolean allMetadata  
      protected java.util.ArrayList matchItems  
      protected java.util.HashMap metadataFields  

    • Constructor Summary

      Constructors 
      Constructor Description
      DocClassSpec()  
      DocClassSpec​(org.apache.manifoldcf.core.interfaces.SpecificationNode sn)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int appendMatch​(java.lang.String matchType, java.lang.String matchField, java.lang.String matchValue)
      Add a match
      boolean checkMetadataIncluded​(java.lang.String fieldName)
      Check if a metadata field is included
      boolean getAllMetadata()
      Get 'all metadata' flag
      int getMatchCount()
      Get the number of matches
      java.lang.String getMatchField​(int matchIndex)
      For a given match, get its field name
      java.lang.String getMatchType​(int matchIndex)
      For a given match, get its type
      java.lang.String getMatchValue​(int matchIndex)
      For a given match, get its match value
      java.lang.String[] getMetadataFields()
      Get the list of metadata fields
      void setAllMetadata​(boolean value)
      Set metadata to "all metadata"
      void setMetadataField​(java.lang.String fieldName)
      Add a metadata field to include

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • allMetadata

        protected boolean allMetadata

      • metadataFields

        protected java.util.HashMap metadataFields

      • matchItems

        protected java.util.ArrayList matchItems

    • Constructor Detail

      • DocClassSpec

        public DocClassSpec()

      • DocClassSpec

        public DocClassSpec​(org.apache.manifoldcf.core.interfaces.SpecificationNode sn)

    • Method Detail

      • setAllMetadata

        public void setAllMetadata​(boolean value)
        Set metadata to "all metadata"

      • setMetadataField

        public void setMetadataField​(java.lang.String fieldName)
        Add a metadata field to include

      • appendMatch

        public int appendMatch​(java.lang.String matchType,
                       java.lang.String matchField,
                       java.lang.String matchValue)
        Add a match

      • getAllMetadata

        public boolean getAllMetadata()
        Get 'all metadata' flag

      • getMetadataFields

        public java.lang.String[] getMetadataFields()
        Get the list of metadata fields

      • checkMetadataIncluded

        public boolean checkMetadataIncluded​(java.lang.String fieldName)
        Check if a metadata field is included

      • getMatchCount

        public int getMatchCount()
        Get the number of matches

      • getMatchType

        public java.lang.String getMatchType​(int matchIndex)
        For a given match, get its type

      • getMatchField

        public java.lang.String getMatchField​(int matchIndex)
        For a given match, get its field name

      • getMatchValue

        public java.lang.String getMatchValue​(int matchIndex)
        For a given match, get its match value