Package com.im.df.api.capabilities
Interface StructureEntityCapability
-
- All Superinterfaces:
DFCapability
- All Known Subinterfaces:
JChemBaseEntityCapability
,JChemCartridgeCapability
,JChemCartridgeJChemBaseCapability
,JChemCartridgeStandardCapability
,JChemEntityCapability
public interface StructureEntityCapability extends DFCapability
Interface for the structure entity.- Since:
- 19.10.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default chemaxon.sss.search.JChemSearchOptions
defaultJChemSearchOptions(DFOperator op)
Creates default JChemSearchOptions for the specific operator.int
getJchemTableType()
Returns the JChem table type for this structure entity.boolean
isEmptyStructuresAllowed()
Says if this structure entity can store empty structures.chemaxon.sss.search.JChemSearchOptions
newJChemSearchOptionsFromOld(chemaxon.sss.search.JChemSearchOptions oldOptions, DFOperator op)
Creates new JChemSearchOptions based on old options for the specific operator.java.util.List<DFOperator>
supportedOperators()
Structure operators supported by this entity.boolean
supportsNonHits()
Says if this structure entity supports non-hit search (set complement of a search).default boolean
supportsOptions(DFOperator operator)
Says if givenDFOperator
can have one or more options for this structure entity type.
-
-
-
Method Detail
-
isEmptyStructuresAllowed
boolean isEmptyStructuresAllowed()
Says if this structure entity can store empty structures.- Returns:
true
if this structure entity can store empty structures,false
otherwise
-
getJchemTableType
int getJchemTableType()
Returns the JChem table type for this structure entity. The type is defined by one of theTableType
constants. Choose the most specific table type for the type of structures you have as this will give you the optimal search features. Note: the naming of this method is inconsistent. It should be getJChemTableType().- Returns:
- The table type
-
supportsNonHits
boolean supportsNonHits()
Says if this structure entity supports non-hit search (set complement of a search).- Returns:
true
if this structure entity supports non-hit search,false
otherwise- Since:
- 20.4.0
-
supportedOperators
java.util.List<DFOperator> supportedOperators()
Structure operators supported by this entity.- Returns:
- supported structure operators
-
supportsOptions
default boolean supportsOptions(DFOperator operator)
Says if givenDFOperator
can have one or more options for this structure entity type.- Parameters:
operator
- operator to check- Returns:
true
if given operator has one or more options,false
if no options are available for given operator and this entity type
-
defaultJChemSearchOptions
default chemaxon.sss.search.JChemSearchOptions defaultJChemSearchOptions(DFOperator op)
Creates default JChemSearchOptions for the specific operator.- Parameters:
op
- structure operator- Returns:
- new JChemSearchOptions instance
-
newJChemSearchOptionsFromOld
chemaxon.sss.search.JChemSearchOptions newJChemSearchOptionsFromOld(chemaxon.sss.search.JChemSearchOptions oldOptions, DFOperator op)
Creates new JChemSearchOptions based on old options for the specific operator. Sets default values.- Parameters:
oldOptions
- originalJChemSearchOptions
, can benull
op
- structure operator- Returns:
- new JChemSearchOptions instance
-
-